Skip to navigation

Permanently delete objects

View as Markdown

Permanently deletes up to 200 objects of a definition in a space. The objects cannot be restored. Authorization: requires space:contribute on :spaceId. Lacking it gives 403 (no space:read gives 404). Body: { ids } (1 to 200). An unknown id is ignored, so a retry is safe. Returns { deleted, ids }: the count and the ids of the deleted objects.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired
definitionIdstringRequired

Request

This endpoint expects an object.
idslist of stringsRequired
The ids of the objects to delete permanently. An unknown id is ignored.

Response

The deleted count.
deleteddouble
How many objects the request deleted.
idslist of strings
The ids of the deleted objects. An unknown id is not in this list.

Errors

403
Forbidden Error