Skip to content

Reply on a support request

Platform module

POST/support-tickets/{id}/replysupportTickets.reply

Adds a message as the requester or a responder (app.post_support_message). A closed request takes no messages (support_ticket_closed: 422); a requester's reply reopens a waiting request. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability me.account.write.
  • OAuth scopes: me.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

supportTickets.reply: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the support ticket.

Request body: SupportTicketReplyRequest

supportTickets.reply: SupportTicketReplyRequest
FieldTypeRequiredDescription
bodystringYesMessage text.Constraints: length 1 to 20000
{
  "body": "Zone B, backstage."
}

Response 201: SupportTicketMessage

supportTickets.reply: SupportTicketMessage
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the support ticket message.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
support_ticket_idstring (uuid)YesIdentifier of the support request.
author_membership_idstring (uuid) | nullYesIdentifier of the member who wrote it; null for the platform team.
bodystringYesMessage text.Constraints: length 1 to 20000
{
  "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",
  "support_ticket_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "author_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "body": "Which zone did you pick?"
}

Code samples

curl -X POST "$XOS_BASE_URL/support-tickets/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/reply" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"body":"Zone B, backstage."}'
const { data } = await xos.supportTickets.reply("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "body": "Zone B, backstage."
  });
response = xos.support_tickets.reply("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"body": "Zone B, backstage."})
xos support-tickets reply 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"body":"Zone B, backstage."}'