This section provides the steps for deleting multiple objects from the tenant. You can remove only objects that are non-archived, as this endpoint serves to change the state of objects from non-archived to archived.
HTTP responses
HTTP response status code | Interpretation |
200 OK | Objects deleted successfully |
206 Partial Content | Some deletions failed due to one or more of the following:
When all deletions fail, a 206 is still returned. |
400 Bad Request | One or more validation errors occurred. The format of one or more |
401 Unauthorized | Invalid or missing API key secret and/or tenant |
Condition
To delete an object of a specific object type, you must have permissions for that object definition
To delete existing objects, make a DELETE request to the /objects endpoint specifying:
Resource/endpoint destination URL
The header for your API request
The request body, which must contain a list of strings of object IDs that you want to have removed from the tenant
To delete two objects with the IDs 64787c4cf75963e01025b23d and 64787c5d5b34e7232a4f7480, we pass the DELETE request to the URI https://public-api.eu.bluedolphin.app/v1/objects.
curl -L -X DELETE 'https://public-api.eu.bluedolphin.app/v1/objects' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json' \
-d '{
"object_ids": ["64787c4cf75963e01025b23d", "64787c5d5b34e7232a4f7480"]
}'A successful call returns a response with a 200 OK HTTP status code and the following body:
{
"result": "OK"
}