Skip to content
XOS Developers

Delete a custom object relation

Platform module

DELETE/custom-object-relations/{id}customObjectRelations.delete

A relation from a custom object record to another record. Soft-deletes the custom object relation: 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

customObjectRelations.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the custom object relation.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/custom-object-relations/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.customObjectRelations.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.custom_object_relations.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos custom-object-relations delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f