Start a direct conversation

Módulo Workforce

POST/conversations/start-directconversations.startDirect

Opens, or returns, the one-to-one conversation with another active member of the org. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad inbox.notifications.write.
Alcances de OAuth: inbox.
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: DirectConversationRequest

conversations.startDirect: DirectConversationRequest
Campo	Tipo	Obligatorio	Descripción
other_membership_id	string (uuid)	Sí	The other member.

{
  "other_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 200: Conversation

conversations.startDirect: Conversation
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the conversation.
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í	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
conversation_kind	"Direct" \| "Group"	Sí	Direct or Group.
group_id	string (uuid) \| null	Sí	Identifier of the group whose conversation this is.
direct_key	string \| null	Sí	The two membership ids of a Direct conversation, sorted and joined by a colon.Restricciones: length 1 to 80
last_message_at	string (date-time) \| null	Sí	When the latest message was sent.

{
  "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",
  "conversation_kind": "Direct",
  "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "direct_key": "a:b",
  "last_message_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/conversations/start-direct" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"other_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.conversations.startDirect({
    "other_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.conversations.start_direct({"other_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos conversations start-direct --data '{"other_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'