unsubscribe_contact
Unsubscribes a contact with a confirmed opt-in from all marketing messages and sends no message. It cannot be undone through the API; only the contact can sign up again. Returns the contact.
| Tool name | unsubscribe_contact |
| Permission | contacts:unsubscribe |
readOnlyHint | false |
destructiveHint | true |
idempotentHint | true |
openWorldHint | false |
| REST call | POST /v1/contacts/{contact_id}/unsubscribe |
#What it does
- Changes data in your account. It does not send messages to contacts.
- Overwrites existing data.
- Safe to repeat with the same idempotency_key.
#Input
The tool takes one flat object. Path, query and body fields of the REST call are merged into it.
| Name | Type | Required | Description |
|---|---|---|---|
contact_id | string | yes | Contact ID. |
Arguments added by the MCP server (see Special arguments)
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | no | Optional. Unique key, for example a UUID. Same key and arguments within 24 hours: first result. up to 255 characters |
confirmed_by_user | boolean | yes | Set to true only after the user has explicitly confirmed this action in the conversation. always true |
#Result
The result has the same content as the REST answer. Lists have at most 50 items per page (default 20); use cursor for the next page.
Errors come back as a tool result with isError: true. The error codes are the ones in Errors.