Answer a request

POST/help-desk-requests/{id}/answerhelpDeskRequests.answer

A team member answers; the first answer records the response time. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

• Requires the capability inbox.notifications.write.
• OAuth scopes: inbox.
• 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

Request body: AnswerHelpDeskRequest

{
  "body": "Restarting the profile now."
}

Response 201: HelpDeskAnswer

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

Code samples

curl -X POST "$XOS_BASE_URL/help-desk-requests/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/answer" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"body":"Restarting the profile now."}'

const { data } = await xos.helpDeskRequests.answer("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "body": "Restarting the profile now."
  });

response = xos.help_desk_requests.answer("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"body": "Restarting the profile now."})

xos help-desk-requests answer 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"body":"Restarting the profile now."}'