Unsubscribe the sender
Act on an unsubscribe request, as the inbox's Unsubscribe button does: the contact the conversation is linked to, who replied to a campaign asking to…
https://app.usenotix.dev/api/v1/inbound/conversations/{id}/unsubscribeNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Act on an unsubscribe request, as the inbox's Unsubscribe button does: the contact the conversation is linked to, who replied to a campaign asking to stop, is unsubscribed from their contact book and leaves any journeys, and the thread records it. Notix acts only when the first message of the conversation answers a campaign, reads as a request to unsubscribe, comes from a sender whose domain passed DMARC, and the contact is still subscribed; otherwise the answer is 400. A team can do this 30 times a minute.
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
Headers
Bearer followed by your API key.
Errors
The conversation holds no unsubscribe request Notix can act on (see the description).
`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 team unsubscribed 30 contacts from the inbox in the last minute.
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>/unsubscribe" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.conversations.unsubscribe("cnv_123");
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"unsubscribed": true
}