Create a custom object relation

Módulo Platform

POST/custom-object-relationscustomObjectRelations.create

A relation from a custom object record to another record. Creates a custom object relation. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad work.record.write.
Alcances de OAuth: work.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: CustomObjectRelationCreate

customObjectRelations.create: CustomObjectRelationCreate
Campo	Tipo	Obligatorio	Descripción
from_record_id	string (uuid)	Sí	Identifier of the custom object record the link starts from.
relation_key	string	Sí	Name of the relation, such as sponsor or venue.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
to_custom_record_id	string (uuid) \| null	No	Identifier of the linked custom object record.
to_record_id	string (uuid) \| null	No	Identifier of the linked record.
to_project_id	string (uuid) \| null	No	Identifier of the linked project.
to_counterparty_id	string (uuid) \| null	No	Identifier of the linked counterparty organization.
to_person_id	string (uuid) \| null	No	Identifier of the linked person.

{
  "from_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "relation_key": "sponsor",
  "to_custom_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: CustomObjectRelation

customObjectRelations.create: CustomObjectRelation
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the custom object relation.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
from_record_id	string (uuid)	Sí	Identifier of the custom object record the link starts from.
relation_key	string	Sí	Name of the relation, such as sponsor or venue.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
to_custom_record_id	string (uuid) \| null	Sí	Identifier of the linked custom object record.
to_record_id	string (uuid) \| null	Sí	Identifier of the linked record.
to_project_id	string (uuid) \| null	Sí	Identifier of the linked project.
to_counterparty_id	string (uuid) \| null	Sí	Identifier of the linked counterparty organization.
to_person_id	string (uuid) \| null	Sí	Identifier of the linked person.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "from_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "relation_key": "sponsor",
  "to_custom_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/custom-object-relations" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"from_record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","relation_key":"sponsor","to_custom_record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.customObjectRelations.create({
    "from_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "relation_key": "sponsor",
    "to_custom_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "to_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "to_project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "to_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "to_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.custom_object_relations.create({"from_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "relation_key": "sponsor", "to_custom_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "to_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "to_project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "to_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "to_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos custom-object-relations create --data '{"from_record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","relation_key":"sponsor","to_custom_record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","to_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'