Contacts

Contacts with tags, custom fields and consent records, and segments (saved filters) to send to.

Method Path Summary Scope Sandbox
GET /v1/{number}/contacts Your contacts, newest first messages:read reads
POST /v1/{number}/contacts Make or update contacts (one, or a list of up to 1000) contacts:manage real change
POST /v1/{number}/contacts/import Import contacts from CSV or JSON (up to 5000 rows) contacts:manage real change
GET /v1/{number}/contacts/export.csv All contacts as CSV messages:read reads
GET /v1/{number}/contacts/{identity} One contact messages:read reads
PATCH /v1/{number}/contacts/{identity} Change a contact contacts:manage real change
DELETE /v1/{number}/contacts/{identity} Delete a contact record contacts:manage simulated
POST /v1/{number}/contacts/{identity}/consent Record consent (or its withdrawal) with evidence contacts:manage real change
GET /v1/{number}/segments Your segments (saved contact filters) messages:read reads
POST /v1/{number}/segments Save a contact filter as a segment contacts:manage real change
GET /v1/{number}/segments/{id} One segment, with how many contacts match now messages:read reads
PUT /v1/{number}/segments/{id} Rename a segment or replace its filter contacts:manage real change
DELETE /v1/{number}/segments/{id} Delete a segment (its contacts stay) contacts:manage real change
GET /v1/{number}/segments/{id}/contacts The contacts a segment matches now messages:read reads
GET /v1/{number}/blocked WhatsApp users this number blocked messages:read reads
POST /v1/{number}/blocked Block WhatsApp users contacts:manage refused
DELETE /v1/{number}/blocked Unblock WhatsApp users contacts:manage refused
GET /v1/{number}/contact-book/{bsuid} Is a phone number on file for a business-scoped user id messages:read reads
DELETE /v1/{number}/contact-book/{bsuid} Remove a business-scoped user id from the contact book contacts:manage refused
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.