Create an engagement message
Gateway module
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.
- Requires the capability opportunities.engagement.write.
- OAuth scopes: opportunities.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: EngagementMessageCreate
| Field | Type | Required | Description |
|---|---|---|---|
| engagement_thread_id | string (uuid) | Yes | Identifier of the thread. |
| body | string | Yes | Message body.Constraints: length 1 to 20000 |
{
"engagement_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"body": "Use the north lot; passes are at the gate."
}Response 201: EngagementMessage
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the engagement message. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| engagement_thread_id | string (uuid) | Yes | Identifier of the thread. |
| body | string | Yes | Message body.Constraints: length 1 to 20000 |
| author_person_id | string (uuid) | null | Yes | Identifier of the sender. |
| sent_at | string (date-time) | Yes | 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"
}Code samples
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."}'