Follow up on an inquiry
Request, parameters, response and errors of POST /v1/inquiries/{id}/followUps.
Last updated:
Sends a follow-up to a person who has not replied. Everything under POST /inquiries/{id}/messages applies: the policy of the MCP tool draft_reply, the answers 201 and 202, the required Idempotency-Key. Without text Athaus uses its standard follow-up for this inquiry. Needs write access to inquiries and the scope propose.
Requires the scope propose and at least the level write on inquiries.
Request
POST https://api.athaus.ai/v1/inquiries/{id}/followUpsParameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | UUID of the inquiry. |
Header
| Name | Type | Required | Description |
|---|---|---|---|
Athaus-Version | string | no | Optional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported. |
Idempotency-Key | string | yes | Required: this operation reaches people outside the office, and a message cannot be taken back. Send a fresh UUID per message and reuse it only to retry the same request: the same key with the same body returns the first answer (a stored 202 stays a 202 with the same proposal) and sends nothing twice. 1 to 255 characters, kept for 24 hours, scoped to the API key and this operation. A different body under the same key is a 422; while the first request still runs it is a 409. Without the header the answer is 400 idempotency_key_missing. |
Request body
JSON with Content-Type: application/json. A field the API does not know is a 400, and errors[].name names the field. The body is required.
| Field | Type | Description |
|---|---|---|
text | string | Your own wording. Without it Athaus uses its standard follow-up for this inquiry. |
Example
curl -X POST "https://api.athaus.ai/v1/inquiries/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17/followUps" \
-H "Authorization: Bearer ath_live_..." \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{}'Response
On success the status is 201 or 202 with Proposal.
Proposal
| Field | Type | Description |
|---|---|---|
object | string | Always proposal. |
id | string | UUID of the proposal. |
status | string | One of pending, approved, executed, failed, rejected, expired. |
action | string | What the proposal does once it is approved. The list is open: new actions arrive, and a client treats an unknown one as a proposal it follows by status. One of inquiry.reply, inquiry.follow_up, listing.publish. |
target | object | What the action is about: an inquiry, or the listing (its listingId) to publish. |
target.object | string | One of inquiry, listing. |
target.id | string | |
text | string | The message that goes to the person who inquired; for listing.publish a sentence naming the listing. Where a human changed a message before approving, the changed text. |
livemode | boolean | false for a proposal of the test office (test keys): approving it records the message as sent in the thread with a note that it was not delivered, and nothing leaves Athaus. |
createdAt | string (date-time) | |
decidedAt | string (date-time) | null | When a human, an API key with the scope decide or the automation of the office said yes or no, or the proposal expired. Null while pending. |
decidedBy | object | null | The API key that said yes or no. Null while pending and when a person or the office's automation decided. |
decidedBy.object | string | Always api_key. |
decidedBy.id | string | |
decidedBy.name | string | null | |
executedAt | string (date-time) | null | When the message was delivered, or the listing went online. Null until then. |
Response headers
| Header | Description |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
ETag | A strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Idempotent-Replayed | true when this is the stored answer to an earlier request with the same Idempotency-Key. |
Location | The proposal: /v1/proposals/{id}. |
Errors
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
400 | invalid_id, api_version_unsupported, invalid_body, idempotency_key_missing | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
409 | address_missing, automation_disabled, idempotency_key_in_use, idempotency_outcome_unknown | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
413 | payload_too_large | The request body is larger than 512 KB. |
415 | invalid_input | The request body is not JSON. Send Content-Type: application/json. |
422 | idempotency_key_reused | The idempotency key was already used with a different request body. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.