Organisations
Answer your person's message on a board
The agent's answer to one message of its own thread, shown at once on its person's screen; the message is marked answered.
POST
/v1/boards/{board}/messages/{message}/repliesTL;DR
| Question | Answer |
|---|---|
| What does it do? | Answer your person's message on a board. |
| What does it take? | A JSON body of type BoardReplyBody. |
| What does it return? | Status 200 with a body of type BoardMessageSent. |
| What can go wrong? | 400 the body is not valid; 401 the API key is missing or not valid; 403 the account's plan does not include the REST API (plan.rest_not_included), the key is a person's own (boards.org_key_required), an organisation key with no member, which has no messages (boards.connection_required), a trusted publisher (boards.publisher_not_allowed), or boards are not on for the organisation (boards.not_enabled); 404 no such board, or one not open to the caller; for a reply, no such message in this connection's thread (boards.message_not_found); 413 the body is larger than the API takes; 422 the reply holds something that looks like a secret, and the organisation blocks them (boards.secret_blocked); 429 too many requests, or a daily limit is spent; 503 live whiteboards are not set up on this server. Every failure uses the one error envelope. |
What it does
The agent's answer to one message of its own thread, shown at once on its person's screen; the message is marked answered. Scanned for secrets. The REST twin of reply_board_message.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
board | string | yes | The board's id: 22 letters and digits. |
message | string | yes | The message answered. |
Request body
The body has the type BoardReplyBody.
| Field | Type | Required | Description |
|---|---|---|---|
text | string | yes | at least 1 character; at most 2000 characters. |
tab | string | null | no | at least 12 characters; at most 12 characters; pattern ^[0-9A-Za-z]+$. |
revision | string | null | no | at least 12 characters; at most 12 characters; pattern ^[0-9A-Za-z]+$. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The reply, as the thread shows it. | BoardMessageSent |
| 400 | The body is not valid. | ErrorResponse |
| 401 | The API key is missing or not valid. | ErrorResponse |
| 403 | The account's plan does not include the REST API (plan.rest_not_included), the key is a person's own (boards.org_key_required), an organisation key with no member, which has no messages (boards.connection_required), a trusted publisher (boards.publisher_not_allowed), or boards are not on for the organisation (boards.not_enabled). | ErrorResponse |
| 404 | No such board, or one not open to the caller; for a reply, no such message in this connection's thread (boards.message_not_found). | ErrorResponse |
| 413 | The body is larger than the API takes. | ErrorResponse |
| 422 | The reply holds something that looks like a secret, and the organisation blocks them (boards.secret_blocked). | ErrorResponse |
| 429 | Too many requests, or a daily limit is spent. | ErrorResponse |
| 503 | Live whiteboards are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type BoardMessageSent.
| Field | Type | Required | Description |
|---|---|---|---|
message | BoardMessage | yes | |
message.id | string | yes | |
message.connection | string | yes | |
message.owner | string | yes | |
message.at | integer | yes | |
message.from | "person" | "agent" | yes | |
message.label | string | yes | |
message.text | string | yes | |
message.tab | string | null | yes | |
message.revision | string | null | yes | |
message.problems | BoardAgentProblem[] | yes | |
message.problems[].code | string | yes | pattern ^[A-Z]\d{3,4}$. |
message.problems[].severity | "error" | "warning" | yes | |
message.problems[].line | integer | yes | minimum 1; maximum 1000000. |
message.problems[].column | integer | yes | minimum 1; maximum 1000000. |
message.problems[].message | string | yes | at least 1 character; at most 500 characters. |
message.problems[].hint | string | null | yes | at least 1 character; at most 500 characters. |
message.inReplyTo | string | null | yes | |
message.status | "sent" | "delivered" | "answered" | yes | sent: kept for the agent; delivered: the agent read it; answered: the agent replied. |
message.deliveredAt | integer | null | yes | |
message.answeredAt | integer | null | yes | |
secrets | object | yes | |
secrets.count | integer | yes | |
secrets.kinds | string[] | yes |
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 |