Create an engagement message

Módulo Gateway

POST/engagement-messagesengagementMessages.create

A message in an engagement thread. Creates an engagement message. 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 opportunities.engagement.write.
Alcances de OAuth: opportunities.
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: EngagementMessageCreate

engagementMessages.create: EngagementMessageCreate
Campo	Tipo	Obligatorio	Descripción
engagement_thread_id	string (uuid)	Sí	Identifier of the thread.
body	string	Sí	Message body.Restricciones: length 1 to 20000

{
  "engagement_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "body": "Use the north lot; passes are at the gate."
}

Respuesta 201: EngagementMessage

engagementMessages.create: EngagementMessage
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the engagement message.
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.
engagement_thread_id	string (uuid)	Sí	Identifier of the thread.
body	string	Sí	Message body.Restricciones: length 1 to 20000
author_person_id	string (uuid) \| null	Sí	Identifier of the sender.
sent_at	string (date-time)	Sí	When it 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",
  "engagement_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "body": "Use the north lot; passes are at the gate.",
  "author_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "sent_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/engagement-messages" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"engagement_thread_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","body":"Use the north lot; passes are at the gate."}'

const { data } = await xos.engagementMessages.create({
    "engagement_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "body": "Use the north lot; passes are at the gate."
  });

response = xos.engagement_messages.create({"engagement_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "body": "Use the north lot; passes are at the gate."})

xos engagement-messages create --data '{"engagement_thread_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","body":"Use the north lot; passes are at the gate."}'