Docs

Start here

Write back on a support request

POST/v1/support/tickets/{reference}/messageson https://api.auray.ai/v1

Add to one of the signed-in account's own requests, as replying to our mail does: the next message of the conversation, and a solved, closed or waiting request opened again.

Add to one of the signed-in account's own requests, as replying to our mail does: the next message of the conversation, and a solved, closed or waiting request opened again. Another account's reference is not found. Called by the desktop for the person signed in; a key you hold is refused 403 support_session_only, since it is not the person asking. Without the desktop, the help form (POST /support/requests) needs no key at all.

#Authentication

Authorization: Bearer auray_sk_… — The desktop's own session key, signed in — a key you hold is refused 403 support_session_only. Without the desktop, the help form needs no key.

#Request

#Path parameters

NameTypeRequiredDescription
referencestringyesThe request's reference, as GET /support/tickets lists it.

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
messagestringyes—1 to 20000 characters.

#Example request

curl -X POST https://api.auray.ai/v1/support/tickets/…/messages \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "message": "…"
}'

#Responses

#201 Created

Added.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "support_message".
referencestringyes—
seqintegeryes—
statusstringyes—One of "new", "open", "pending", "on_hold", "solved", "closed".

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-Request-Id

#400 Bad Request

support_message_invalid, invalid_body or invalid_json.

The error body: error, message, docs (the entry that explains it) and request_id.

#401 Unauthorized

missing_authorization, invalid_api_key, key_revoked or key_expired.

The error body: error, message, docs (the entry that explains it) and request_id.

#403 Forbidden

support_session_only — this is the desktop's door.

The error body: error, message, docs (the entry that explains it) and request_id.

#404 Not Found

not_found — the account has no request with that reference.

The error body: error, message, docs (the entry that explains it) and request_id.

#413 Payload Too Large

body_too_large — the body must be at most 65536 bytes.

The error body: error, message, docs (the entry that explains it) and request_id.

#429 Too Many Requests

support_rate_limited — this account has written several times just now — or rate_limited, the key's write bucket.

The error body: error, message, docs (the entry that explains it) and request_id.

#503 Service Unavailable

support_disabled, support_not_configured or support_unavailable.

The error body: error, message, docs (the entry that explains it) and request_id.

#Status codes

StatusMeaning
201Added.
400support_message_invalid, invalid_body or invalid_json.
401missing_authorization, invalid_api_key, key_revoked or key_expired.
403support_session_only — this is the desktop's door.
404not_found — the account has no request with that reference.
413body_too_large — the body must be at most 65536 bytes.
429support_rate_limited — this account has written several times just now — or rate_limited, the key's write bucket.
503support_disabled, support_not_configured or support_unavailable.

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close