Deleting an entity

Use this request to delete an entity: a goal, project, or project portfolio.

DELETE

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>?withBoard=true

Query format

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

To delete an entity, use an HTTP DELETE request.

DELETE /v3/entities/<entity_type>/<entity_ID>?withBoard=true
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 Administration → Organizations 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. You can use the id or shortId parameter as the ID. String
Request parameters

Additional parameters

Parameter Description Data type
withBoard Delete together with the board Boolean

Example: Deleting a project

  • An HTTP DELETE method is used.
  • The project is deleted together with the board.
DELETE https://api.tracker.yandex.net/v3/entities/project/655f328da834c763********?withBoard=true

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:

401
The user is not authorized. Make sure that actions described in the API access section are performed.
403
You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Updating an entity
Next
Getting a list of entities