Set a conversation's status
Mark a conversation OPEN, PENDING (answered, waiting for the customer) or CLOSED.
https://app.usenotix.dev/api/v1/inbound/conversations/{id}/statusNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Mark a conversation OPEN, PENDING (answered, waiting for the customer) or CLOSED. The thread records the change.
Who can call it
A full access key only. Every other key answers 403 SCOPE_DENIED (send-only, read-only and live AI keys).
Whose inbox
The key acts as the person who created it, as they are on the team today: a team admin sees every inbox, a member only the inboxes they belong to. Read marks are that person's, and notes, assignments and replies carry their name. A key whose creator left the team, or made before Notix recorded who made each key, answers 403 FORBIDDEN. A key limited to one domain sees only the inboxes that receive mail on that domain. The thread does not say a change came through the API: it carries the creator's name, and the key's audit log (GET /v1/audit-log) records which key made it.
The team can make 120 inbox reads a minute through the API; when Notix cannot count them the answer is 503 SERVICE_UNAVAILABLE (try again shortly), never a 429.
Path parameters
Body parameters
OPEN: waiting for the team. PENDING: the team answered and waits for the customer. CLOSED: done.
One of OPEN, PENDING, CLOSED.
Headers
Bearer followed by your API key.
Errors
`status` is not OPEN, PENDING or CLOSED.
`SCOPE_DENIED`: the key is not a full access key (send-only, read-only or live AI). `FORBIDDEN`: the key's creator has left the team, or the key is older than Notix's record of who made each key.
No conversation with this id that the key's creator can see (or, for a pinned key, on its domain).
The inbox's rate counters, or the sending counters, cannot be read just now; nothing was done. Try again shortly.
Every error has the same shape. See all error codes.
curl -X POST "https://app.usenotix.dev/api/v1/inbound/conversations/<id>/status" \
-H "Authorization: Bearer $NOTIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "CLOSED"
}'
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.conversations.setStatus("cnv_123", "CLOSED");
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"status": "OPEN"
}