Delete a custom object record
Platform module
DELETE/objects/{object_key}/{id}objects.delete
A record of a custom object. Values are stored one row per field, never as JSON. Soft-deletes the custom object record: it moves to Trash and can be restored for its table's retention period.
- Requires the capability work.record.write.
- OAuth scopes: work.
- Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| object_key | string | Yes | The `object_key` path segment.Constraints: length 1 to any |
| id | string (uuid) | Yes | Identifier of the custom object record. |
Response 204: no body.
Code samples
curl -X DELETE "$XOS_BASE_URL/objects/sponsor_activation/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data } = await xos.objects.delete("sponsor_activation", "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.objects.delete("sponsor_activation", "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos objects delete sponsor_activation 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f