Organisations
Ask the organisation's named contact for help
A subject, a message and a severity, stored for 365 days and emailed to the named contact with the sender as the reply-to.
POST
/orgs/{org}/support/requestsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Ask the organisation's named contact for help. |
| What does it take? | A JSON body of type SupportRequestBody. |
| What does it return? | Status 201 with a body of type SupportAck. |
| What can go wrong? | 400 a field is missing, too long, or not one of the choices; 401 not signed in; 403 a plan without priority support (plan.support_not_included), or the request came from an origin that may not make changes; 404 no such organisation, or the caller is not a member of it; 413 the body is larger than 32 kib; 429 too many requests, or the organisation's requests for the day are used (support.daily_limit); 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
A subject, a message and a severity, stored for 365 days and emailed to the named contact with the sender as the reply-to. Any member of an Enterprise organisation; at most 20 an organisation a day.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type SupportRequestBody.
| Field | Type | Required | Description |
|---|---|---|---|
subject | string | yes | One line on what it is about. 1 to 160 characters. at least 1 character; at most 160 characters. |
message | string | yes | What happened, what was expected, and anything that helps reproduce it. 1 to 5000 characters; line breaks are kept. at least 1 character; at most 5000 characters. |
severity | "question" | "broken" | "urgent" | yes | question for a question, broken when something does not work, urgent when production is affected. The contact reads the urgent ones first. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 201 | Sent. | SupportAck |
| 400 | A field is missing, too long, or not one of the choices. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | A plan without priority support (plan.support_not_included), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 413 | The body is larger than 32 KiB. | ErrorResponse |
| 429 | Too many requests, or the organisation's requests for the day are used (support.daily_limit). | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 201 answer has the type SupportAck.
| Field | Type | Required | Description |
|---|---|---|---|
received | true | yes | |
contactName | string | null | yes | The name of the contact who will answer, or null when none is named. |
firstResponseHours | integer | null | yes | The first response target, in business hours, or null. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |