export_contacts
Stores a copy of the contacts that match the filters (names, numbers, emails) for 24 hours, ready when the call returns; read the rows with get_contact_export. Sends nothing and changes no contact.
| Tool name | export_contacts |
| Permission | contacts:read |
readOnlyHint | false |
destructiveHint | false |
idempotentHint | true |
openWorldHint | false |
| REST call | POST /v1/contact-exports |
#What it does
- Changes data in your account. It does not send messages to contacts.
- 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 |
|---|---|---|---|
query | string | no | Name, phone number or email, or part of it. Case does not matter. up to 100 characters |
tag | string | no | Only contacts with this tag. Case does not matter. up to 60 characters |
optin_whatsapp | string | no | Only contacts with this WhatsApp opt-in status. one of: none, pending, confirmed, opted_out |
created_after | string | no | Only contacts created after this time (ISO 8601). up to 40 characters; format date-time |
created_before | string | no | Only contacts created before this time (ISO 8601). up to 40 characters; format date-time |
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. Without a key only an identical call within 1 minute counts as a repeat. up to 255 characters |
#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.