Deleting a comment

The request allows you to delete an entity comment.

DELETE

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/comments/<comment_ID>

Query format

Before making a request, get permission to access the API.

To delete a comment, use an HTTP DELETE request.

DELETE /v3/entities/<entity_type>/<entity_ID>/comments/<comment_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers
  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to AdministrationOrganizations and copy the value from the ID field.

Resource
Parameter Description Data type
<entity_type> Entity type:
  • project
  • portfolio
  • goal
String
<entity_ID> Entity ID. To get the ID, see the entity list. String
<comment_ID> Comment's unique ID. String or number
Request parameters

Additional parameters

Parameter Description Data type
notify Notify the users specified in the Author, Lead, Participants, Customers, and Followers fields. The default value is true. Boolean
notifyAuthor Notify the author of the changes. The default value is false. Boolean

Example: Delete a comment

  • An HTTP DELETE method is used.
DELETE https://api.tracker.yandex.net/v3/entities/project/<project_ID>/comments/16

Response format

If the request is successful, the API returns a response with code 204.

If the request is processed incorrectly, the API returns a response with an error code:

400
One or more request parameters have an invalid value.
404
The requested object was not found. You may have specified an invalid object ID or key.
422
JSON validation error, the request is rejected.