# Cosend (remote · mcp.cosend.app)

WhatsApp Business inbox for AI apps: read and answer chats, run campaigns, deploy automations.

- Trust score: 84/100 (high trust)
- Change this week: +2
- Registry status: active
- Liveness: live
- Owner verified: no
- Last scored: 2026-11-21

## Components

- remote · `mcp.cosend.app`: 84/100 (this document), [markdown](https://verifymcp.io/servers/app-cosend-mcp/mcp.md), [page](https://verifymcp.io/servers/app-cosend-mcp/mcp)

## Channel facts

- Endpoint: `https://mcp.cosend.app/mcp`
- Transports: `streamable-http`
- Auth: `required`
- Version: `2026.11.16`

## Trust breakdown

How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. Scores are 0–100 per category. Scoring method: https://verifymcp.io/docs/scoring (what has changed: https://verifymcp.io/docs/scoring/changelog)

Scored 2026-11-21.

- **Endpoint Security**: 97/100
  - The endpoint's TLS certificate is valid, in date, and uses a strong key.
  - Authorisation is enforced on tool calls, advertised via RFC 9728 protected-resource metadata. Discovery is public, which costs nothing: no tool can be invoked without a token.
  - HTTPS is enforced; there's no plaintext access path.
  - The HSTS (Strict-Transport-Security) header is present.
  - DNSSEC check failed: this domain isn't protected by DNSSEC.
  - The authorisation server supports Client ID Metadata Documents, the current MCP client-registration mechanism.
- **Transport & Reachability**: 100/100
  - Verified streamable-http transport via a live MCP handshake.
- **Schema Quality & AI Usability**: 59/100
  - AI-judged instruction clarity (good).
  - Context-footprint check failed: tool/resource definitions use about 30302 tokens (~242/item across 125 items; 125 tools + 0 resources), over budget; trim descriptions and params.
  - Usage-examples check failed: none of the tools include examples.
- **Stability & Change Management**: 50/100
  - Stability check failed: schema churn in the 18 days we've observed: 2 tool removals, 1 breaking changes, 0 auth/transport breaks, 102 additions.
- **Tool Coverage**: 91/100
  - 100% of tools have a non-trivial description (not blank, and not just the tool's name).
  - 70% of tool parameters carry a description.
  - Structured output schemas are declared (1% of tools); any adoption earns full credit.
- **Tool Safety**: 100/100
  - No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.
  - All 6 tool(s) whose name or description implies an irreversible operation declare an MCP destructiveHint annotation.
  - An AI judge read all 126 captured unit(s) of tool text and found none that tries to manipulate the model reading it.
- **Capabilities**: 100/100
  - Implements a current MCP spec version (2026-07-28).

## Install

### How do I install the Cosend MCP server?

Cosend is a hosted endpoint at https://mcp.cosend.app/mcp, so there is nothing to install locally. Ready-made configuration for Claude, Cursor, VS Code, Codex and 5 more is on this page, copied from each client's own documentation.

### Claude

```bash
claude mcp add --transport http app-cosend-mcp 'https://mcp.cosend.app/mcp'
```

### Cursor

```json
{
  "mcpServers": {
    "app-cosend-mcp": {
      "url": "https://mcp.cosend.app/mcp"
    }
  }
}
```

### VS Code

```json
{
  "servers": {
    "app-cosend-mcp": {
      "type": "http",
      "url": "https://mcp.cosend.app/mcp"
    }
  }
}
```

### Codex

```toml
[mcp_servers.app-cosend-mcp]
url = "https://mcp.cosend.app/mcp"
```

### opencode

```json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "app-cosend-mcp": {
      "type": "remote",
      "url": "https://mcp.cosend.app/mcp",
      "enabled": true
    }
  }
}
```

### OpenClaw

```bash
openclaw mcp add app-cosend-mcp --url 'https://mcp.cosend.app/mcp' --transport streamable-http
```

### Hermes

```yaml
mcp_servers:
  app-cosend-mcp:
    url: "https://mcp.cosend.app/mcp"
```

### Netclaw

```json
{
  "McpServers": {
    "app-cosend-mcp": {
      "Transport": "http",
      "Url": "https://mcp.cosend.app/mcp"
    }
  }
}
```

### Vellum

```bash
assistant mcp add app-cosend-mcp -t streamable-http -u 'https://mcp.cosend.app/mcp'
```

### Other

```json
{
  "mcpServers": {
    "app-cosend-mcp": {
      "type": "http",
      "url": "https://mcp.cosend.app/mcp"
    }
  }
}
```

The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.

## Changelog

Every change recorded for this component, newest first. Days that predate change tracking, or that we cannot explain, say so: "we were watching and nothing happened" and "we were not watching" are different claims.

### 2026-11-21 (score 84, +1)

No change was recorded against any check on this day. Stability & Change Management went from 46 to 50.

### 2026-11-20 (score 83, 0)

- [security] Tool “rollback_automation” rewrote its description, which is the text the model reads
- [security] Tool “switch_on_automation” rewrote its description, which is the text the model reads

### 2026-11-19 (score 83, +1)

No change was recorded against any check on this day. Stability & Change Management went from 40 to 43.

### 2026-11-18 (score 82, 0)

- [security] Tool “get_inbox_overview” rewrote its description, which is the text the model reads
- [cosmetic] “update_contact” reworded the description of “attributes”
- [cosmetic] “upsert_contact” reworded the description of “attributes”

### 2026-11-17 (score 82, −1)

- [security regression] Stability: 0.43 → fail
- [security regression] A breaking change shipped without a version bump: still 1.0.0
- [security regression] Tool “automation_recipes” was removed
- [security regression] Tool “describe_automation” was removed
- [security regression] Tool “draft_reply” was removed
- [security regression] Tool “get_authoring_chat” was removed
- [security regression] Tool “get_automation_catalogue” was removed
- [security regression] Tool “manage_automation” was removed
- [security regression] Tool “set_automation_state” was removed
- [security regression] Tool “translate_message” was removed
- [security regression] Tool “upsert_automation” was removed
- [security] The server rewrote its instructions, which are the text every model session reads
- [security] New tool “buy_cosend_number”, which the server declares destructive
- [security] New tool “copy_automation”, which the server declares destructive
- [security] New tool “create_custom_automation”, which the server declares destructive
- [security] New tool “delete_automation”, which the server declares destructive
- [security] New tool “keep_cosend_number”, which the server declares destructive
- [security] New tool “rollback_automation”, which the server declares destructive
- [security] New tool “set_up_accurate_warehouse_arrival”, which the server declares destructive
- [security] New tool “set_up_ai_receptionist”, which the server declares destructive
- [security] New tool “set_up_appointment_reminder”, which the server declares destructive
- [security] New tool “set_up_lead_capture”, which the server declares destructive
- [security] New tool “set_up_missed_call_text_back”, which the server declares destructive
- [security] New tool “set_up_order_confirmation”, which the server declares destructive
- [security] New tool “set_up_order_updates”, which the server declares destructive
- [security] New tool “set_up_payment_reminder”, which the server declares destructive
- [security] New tool “set_up_quote_intake”, which the server declares destructive
- [security] New tool “set_up_review_request”, which the server declares destructive
- [security] New tool “set_up_welcome_menu”, which the server declares destructive
- [security] New tool “stop_cosend_number”, which the server declares destructive
- [security] New tool “switch_off_automation”, which the server declares destructive
- [security] New tool “switch_on_automation”, which the server declares destructive
- [security] New tool “update_accurate_warehouse_arrival”, which the server declares destructive
- [security] New tool “update_ai_receptionist”, which the server declares destructive
- [security] New tool “update_appointment_reminder”, which the server declares destructive
- [security] New tool “update_automation_details”, which the server declares destructive
- [security] New tool “update_custom_automation”, which the server declares destructive
- [security] New tool “update_lead_capture”, which the server declares destructive
- [security] New tool “update_missed_call_text_back”, which the server declares destructive
- [security] New tool “update_order_confirmation”, which the server declares destructive
- [security] New tool “update_order_updates”, which the server declares destructive
- [security] New tool “update_payment_reminder”, which the server declares destructive
- [security] New tool “update_quote_intake”, which the server declares destructive
- [security] New tool “update_review_request”, which the server declares destructive
- [security] New tool “update_welcome_menu”, which the server declares destructive
- [security] Tool “deploy_automation” rewrote its description, which is the text the model reads
- [security] Tool “get_report” rewrote its description, which is the text the model reads
- [security] Tool “import_contacts” rewrote its description, which is the text the model reads
- [security] Tool “manage_number” rewrote its description, which is the text the model reads
- [security] Tool “run_automation” rewrote its description, which is the text the model reads
- [security] Tool “send_campaign” rewrote its description, which is the text the model reads
- [security] Tool “update_campaign” rewrote its description, which is the text the model reads
- [functional regression] Schema quality: 215 → 241
- [functional regression] “deploy_automation” added a required parameter “actions”, so existing callers break
- [functional regression] “run_automation” added a required parameter “actions”, so existing callers break
- [functional] First check of Tool coverage: 1
- [functional] New tool “list_automation_building_blocks”
- [functional] New tool “list_automation_recipes”
- [functional] New tool “list_cosend_numbers”
- [cosmetic] “import_contacts” added an optional parameter “details”
- [cosmetic] “import_contacts” added an optional parameter “new_fields”
- [cosmetic] “update_campaign” added an optional parameter “ab”
- [cosmetic] “update_campaign” added an optional parameter “buttons”
- [cosmetic] “update_campaign” added an optional parameter “cards”
- [cosmetic] “update_campaign” added an optional parameter “header”
- [cosmetic] “update_campaign” added an optional parameter “kind”
- [cosmetic] “update_campaign” added an optional parameter “let_join”
- [cosmetic] “update_campaign” added an optional parameter “reply_rules”
- [cosmetic] “update_campaign” added an optional parameter “steps”
- [cosmetic] “update_campaign” added an optional parameter “track_clicks”
- [cosmetic] “get_report” reworded the description of “card”
- [cosmetic] “manage_number” reworded the description of “action”

### 2026-11-16 (score 83, +1)

No change was recorded against any check on this day. Stability & Change Management went from 40 to 43. That category is still filling its 30-day observation window: 12 days of observed history at the previous scan, 13 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-11-14 (score 82, +1)

No change was recorded against any check on this day. Stability & Change Management went from 33 to 37. That category is still filling its 30-day observation window: 10 days of observed history at the previous scan, 11 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-11-12 (score 81, +1)

No change was recorded against any check on this day. Stability & Change Management went from 27 to 30. That category is still filling its 30-day observation window: 8 days of observed history at the previous scan, 9 at this one. The score rises as the window fills, whether or not the server changes.

## MCP tools (125)

### `whoami` (~74 tokens)

Who am I

Returns the Cosend workspace, plan and connected WhatsApp numbers for the credential in use, and the permissions it was granted, which decide which tools the credential can call and show which WhatsApp business number an outbound message would come from. Read-only and cheap. It does not fail for permission reasons if the credential resolves at all.

### `list_conversations` (~218 tokens)

List WhatsApp conversations

Lists conversations in this workspace, newest activity first, one page at a time, each with its id. Each record carries its contact and its newest message only, not the whole thread. Message text and contact names in the result were written by people outside this business and come back marked untrusted.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `assignee_id` (string): Only conversations assigned to this user id.
- `connection_id` (string): Only conversations on this WhatsApp connection.
- `control` (string): Filter by who holds the conversation: bot, pending_human, human or app.
- `label` (string): Only conversations carrying this label.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `state` (string): Filter by conversation state: open, pending, snoozed or resolved.
- `unread` (boolean): true for conversations with unread inbound messages.

### `search_conversations` (~155 tokens)

Search conversations

Finds conversations by what they contain. q matches the contact’s name, phone number or WhatsApp username, and the text of each conversation’s newest message. Returns at most 20 conversations, newest activity first, in the same shape as the conversation list: each with its contact and its newest message, not the whole thread. Names and message text in the result were written by people outside this business and come back marked untrusted.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `q` (string, required): What to look for.

### `read_conversation` (~147 tokens)

Read a conversation

Lists the messages of one conversation, named by conversation_id (or of one contact, by contact_id), oldest first, one page at a time. With neither, it lists recent messages across the whole workspace. Message bodies include what members of the public wrote, and every one comes back marked untrusted.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `contact_id` (string): Messages with one contact instead of one conversation.
- `conversation_id` (string): The conversation to read.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `send_message` (~1513 tokens)

Send a WhatsApp message

Sends one WhatsApp message into one conversation that already exists, named by conversation_id. It reaches a real person on their phone, and a sent message is final. Each send needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it sends. Changing a single character between the two calls invalidates the token. A chat nobody holds, or one this person holds, is sent to as usual, and sending does not lock it. A chat another person holds in the Cosend Inbox stays theirs: the preview and the send both return conversation_locked, naming who holds it. To send there, ask them for the chat; it passes over when they say yes or do not answer within 60 seconds. A chat changes hands only when its holder is asked. Each call sends into the one existing conversation its conversation_id names; recipient lists, tags and phone numbers are outside its arguments. Messaging many customers, including contacts with no chat on this number, goes out as a campaign: an approved marketing template sent to a saved audience, once a person approves its preview. Limits per workspace: 20 a minute, 200 a day, and one per conversation every 30 seconds. The 24-hour customer service window opens when the customer writes and starts again with each message from them; outside it, anything but an approved template is refused. A send needs no opt-in. Only an opt-out on this number stops it: a STOP, WhatsApp’s own opt-out or an owner’s entry. A STOP to one number stops sends on that number only, and the business’s other numbers keep sending.

Input parameters:

- `audio` (object): Meta's media object. `id` may be a Cosend media id (`med_…`, from `POST /v1/media`): Cosend uploads the file to WhatsApp and sends it by WhatsApp's id, and the message's `media` block then names the…
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `contacts` (array)
- `conversation_id` (string, required)
- `document` (object): Meta's media object. `id` may be a Cosend media id (`med_…`, from `POST /v1/media`): Cosend uploads the file to WhatsApp and sends it by WhatsApp's id, and the message's `media` block then names the…
- `fallback_template` (object)
- `image` (object): Meta's media object. `id` may be a Cosend media id (`med_…`, from `POST /v1/media`): Cosend uploads the file to WhatsApp and sends it by WhatsApp's id, and the message's `media` block then names the…
- `interactive`: Meta's interactive object. Checked against WhatsApp's limits before anything is written, and refused in words naming the field: a reply-button message (type "button", up to 3 buttons), a list message…
- `location` (object)
- `metadata` (object)
- `reaction` (object)
- `reply_to`
- `send_mode` (string)
- `source` (string): Who is sending. Left out, it is agent for a person (the dashboard Inbox, or an MCP client acting for one) and api for an API key.
- `sticker` (object): Meta's media object. `id` may be a Cosend media id (`med_…`, from `POST /v1/media`): Cosend uploads the file to WhatsApp and sends it by WhatsApp's id, and the message's `media` block then names the…
- `template` (object): Meta's template object: {"name", "language": {"code"}, "components"}. A header parameter of type image, video or document may name a file uploaded with POST /v1/media by its id ({"type": "image", "im…
- `text` (object)
- `type` (string, required)
- `video` (object): Meta's media object. `id` may be a Cosend media id (`med_…`, from `POST /v1/media`): Cosend uploads the file to WhatsApp and sends it by WhatsApp's id, and the message's `media` block then names the…

### `list_contacts` (~137 tokens)

List contacts

Lists contacts in this workspace, one page at a time, optionally filtered, each with its id. Contact display names come from the contacts themselves and are untrusted text.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `connection_id` (string): Only contacts on this WhatsApp connection.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `q` (string): Free-text search over the display name.
- `tag` (array): Only contacts carrying this tag. Repeat for AND semantics.

### `upsert_contact` (~388 tokens)

Create or update a contact

Creates a contact, or updates the one that already exists for that phone number or BSUID (the business-scoped user id Meta sends; a contact may have one and no phone). On a contact that exists only the fields you send change, and nothing is removed: tags are added to its tags, attributes are merged into its attributes, changing the name needs an owner or admin, and profile_name is only filled when WhatsApp has not given one; a field sent as null is left as it is. Writes only to Cosend: it sends nothing and the contact is not notified. Who can be messaged stays the same: a send needs no opt-in, only an opt-out stops one, and opt-outs are recorded on their own ledger.

Input parameters:

- `attributes` (object): Free-form values. PATCH replaces them whole; a POST for a contact that already exists writes the keys sent over its values and removes none. A key registered in /v1/contact-fields must hold a value o…
- `bsuid`
- `connection_id` (string, required)
- `locale`
- `name`
- `phone_e164`
- `profile_name`
- `tags` (array): A new contact gets these tags. A contact that already exists gets them added to its own, and keeps every tag it has.
- `timezone`

### `set_contact_consent` (~130 tokens)

Record a contact’s consent

Records a contact's marketing or utility consent as a new entry in an append-only ledger. Every entry is kept as written, so this is an audit record of what the business was told. A send needs no recorded opt-in. An opt-out recorded here stops that category on the number it is recorded for, and the business’s other numbers keep sending.

Input parameters:

- `category` (string, required)
- `connection_id` (string)
- `evidence` (object)
- `id` (string, required): The id in the resource path.
- `source` (string)
- `state` (string, required)

### `list_templates` (~193 tokens)

List message templates

Lists this workspace’s WhatsApp message templates, one page at a time, with Meta’s review status, whether each can be sent right now (sendable) and, for a rejected one, Meta’s reason. Outside the 24-hour customer service window only an approved template can be sent. Meta reviews every template, and a decision can take up to 24 hours, so one in review cannot be sent. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `category` (string): Only this category: marketing, utility or authentication.
- `language` (string): Only this language, e.g. en_US.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `status` (string): Only templates in this review state, e.g. approved.

### `submit_template` (~859 tokens)

Submit a template for WhatsApp review

Creates a new WhatsApp message template and sends it to Meta for review. This leaves Cosend: Meta reviews every template (a decision can take up to 24 hours), and a rejection counts against the WhatsApp account’s quality history. Each submission needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it submits. Ten a day per workspace. The categories: marketing makes people aware of the business, its offers and sales; utility follows up on something the customer did or asked for (an order, a booking) and may not promote anything, so an order update with a discount in it is marketing; authentication is a one-time code. A wrong category is moved or rejected by Meta. Meta’s answer shows in the template’s review status. It sends no message to anyone.

Input parameters:

- `authentication`: An authentication template, in Meta's shape, in place of components and language: {"languages": ["fr", "en_US"], "add_security_recommendation": true, "code_expiration_minutes": 10, "delivery": {"type…
- `category` (string, required)
- `components` (array): Meta's components; required on every category but authentication, which takes authentication instead. A HEADER carries its format (TEXT, IMAGE, VIDEO, DOCUMENT or LOCATION), and a header without one…
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required)
- `display_name` (string): The human name, free text (e.g. "Order shipped"). When name is left out, the system name is generated from it: lowercase, accents dropped, every other run of characters an underscore, at most 512 cha…
- `example_values` (object): A sample value for every variable in the TEXT header and the body, keyed per component by the name between the braces: {"body": {"1": "Pablo", "2": "860198-230332"}} or {"body": {"first_name": "Pablo…
- `language` (string): The language, e.g. "en_US". Required on every category but authentication, which takes authentication.languages instead.
- `name` (string): The system name, used as given. Optional: leave it out and it is generated from display_name. Give it to add a language to an existing template. One of name and display_name is required.
- `parameter_format` (string)

### `list_automations` (~94 tokens)

List automations

Lists this workspace’s automations, one page at a time, with each one’s status, the version that is live, and today’s runs and failures. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `validate_automation` (~129 tokens)

Check an automation

Checks an automation document (ir) with Cosend’s compiler and returns its full report: every error with a JSON pointer into the document and, where one exists, a fix that can be applied. Nothing is written and nothing is deployed. id is the automation the draft belongs to; a brand-new automation gets its id when it is first saved, and saving checks the document the same way. It needs the automations:write permission because it is the authoring tool, though it changes nothing.

Input parameters:

- `id` (string, required): The id in the resource path.
- `ir` (object, required)

### `list_automation_building_blocks` (~156 tokens)

List automation building blocks

Lists what a custom automation on one WhatsApp number can be built from: each thing it can start on, with the settings it takes and the conditions it can start on; each step it can take, with the inputs it takes and what it returns; each integration working for that number, with its actions and their inputs; and the JSON Schema of the automation document, with the operators and functions a condition is written in. Only what the workspace’s plan includes and the number’s working integrations allow is listed. Read-only: it runs nothing and changes nothing.

Input parameters:

- `connection_id` (string, required): The WhatsApp number (connection id) the automation is for: only what can be built and run on it is listed.

Output parameters:

- `blocks` (array)
- `document_schema` (object): The JSON Schema of an automation document (`ir_version` 1.0): what it starts on, its steps (actions, conditions, branches, loops, waits) and the expressions a condition is written in, each operator a…
- `integrations` (array): Every integration that has actions, with them: what a “Call an integration” step can name as its `integration` and `action`, and what each takes and answers.
- `object` (string)
- `triggers` (array)
- `version` (string)

### `create_custom_automation` (~515 tokens)

Create a custom automation

Creates a new automation on one WhatsApp number from an automation document (ir) written in full, as Cosend’s automation editor saves one: what it starts on, its steps and its limits, in the document schema that ir_version names. What a document can use on a number, each trigger, step and integration action with what it takes, and that schema itself, are in the read-only list of automation building blocks for the number. The document is checked as it is saved; one that does not pass is refused with each failing path as a JSON pointer. A “Run a script” step runs TypeScript written in the step, in a sandbox with no network and nothing imported; an outside address is reached only by a step that calls an allowlisted URL. A document marked as made from a recipe (meta.created_by "recipe") is refused: a recipe is set up and changed with its own tools. slug, name and connection_id name it and its number. It is created switched off: saving it runs nothing and sends nothing, and it acts only once it is deployed and switched on, each of which names every action its steps take. Its runs count against the plan’s allowance as every automation’s do. Each call needs confirming: without confirmation_token it changes nothing and returns a preview naming every action the document’s steps take, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `change_note` (string)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `description`
- `ir` (object, required): The automation’s flow document (the IR), as a JSON object. `ir_version` selects the document schema Cosend validates it against. A document that does not match is refused with `automation_invalid`, w…
- `name` (string, required)
- `slug` (string, required)

### `update_custom_automation` (~381 tokens)

Save a new version of an automation

Saves a new version of one automation, named by id, from an automation document (ir) written in full, as Cosend’s automation editor saves one: what it starts on, its steps and its limits, in the document schema that ir_version names. What a document can use on a number, each trigger, step and integration action with what it takes, and that schema itself, are in the read-only list of automation building blocks for the number. The document is checked as it is saved; one that does not pass is refused with each failing path as a JSON pointer. A “Run a script” step runs TypeScript written in the step, in a sandbox with no network and nothing imported; an outside address is reached only by a step that calls an allowlisted URL. A document marked as made from a recipe (meta.created_by "recipe") is refused: a recipe is set up and changed with its own tools. The automation keeps running the version it ran until the new one is deployed and switched on. Each call needs confirming: without confirmation_token it changes nothing and returns a preview naming every action the document’s steps take, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The id in the resource path.
- `ir` (object, required): The automation’s flow document (the IR), as a JSON object. `ir_version` selects the document schema Cosend validates it against. A document that does not match is refused with `automation_invalid`, w…

### `deploy_automation` (~350 tokens)

Deploy an automation

Compiles one version of an automation, runs Cosend’s safety checks on it and stores the result, so it can be switched on. It does not switch the automation on, and nothing is sent. version_id is the version; left out, the newest. actions names every action the version’s steps take, and those of a second automation set up with it, from the list in the schema (an automation’s versions list theirs as actions); a list that leaves one out or names another is refused, with the right list. The preview refuses that list as the call would, and gives no token. confirm_actions names, one by one, each destructive or money-moving action the person approved; one left unnamed is refused by name. Each call needs confirming: without confirmation_token it changes nothing and returns a preview and a token for a person to approve; called again with that token, it deploys. A confirmed deploy that fails to compile uses up the confirmation.

Input parameters:

- `actions` (array, required): Every action the automation’s steps take, and those of a second automation set up with it, each once: what a person approves it doing. A list that leaves one out, or names one the steps do not take,…
- `confirm_actions` (array)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The id in the resource path.
- `version_id` (string)

### `switch_on_automation` (~358 tokens)

Switch an automation on

Switches one automation on, running the version named (version_id), older or newer, got ready first if it never was; left out, the newest, which deploy_automation gets ready first. A version with a step that has to be confirmed by name is got ready with deploy_automation and confirm_actions first. From then on it acts on its own whenever what it starts on happens, and its steps run as they are built, which can include WhatsApp messages to customers. A recipe set up with a second automation switches on with it. actions names every action the version’s steps take, and the second automation’s, from the list in the schema (an automation’s versions list theirs as actions); a list that leaves one out or names another is refused, with the right list. The preview refuses that list as the call would, and gives no token. Each call needs confirming: without confirmation_token it changes nothing and returns a preview and a token for a person to approve; called again with that token, it switches it on.

Input parameters:

- `actions` (array, required): Every action the automation’s steps take, and those of a second automation set up with it, each once: what a person approves it doing. A list that leaves one out, or names one the steps do not take,…
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The id in the resource path.
- `version_id` (string)

### `switch_off_automation` (~77 tokens)

Switch an automation off

Switches one automation off at once, so it starts on nothing from then on. It needs no confirmation, so it works as an emergency stop. Messages it already sent stay sent. A recipe set up with a second automation switches off with it. Returns the automation.

Input parameters:

- `id` (string, required): The id in the resource path.

### `set_up_ai_receptionist` (~361 tokens)

Set up “AI receptionist”

Sets up Cosend’s “AI receptionist” automation on one WhatsApp number: Answers your customers on WhatsApp from what you teach it, and passes a chat to you when needed. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_order_confirmation` (~373 tokens)

Set up “Order confirmation”

Sets up Cosend’s “Order confirmation” automation on one WhatsApp number: When a customer pays in your shop, they get a WhatsApp message with the order number and total. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. It needs woocommerce connected to the workspace first (by integration key). Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_order_updates` (~375 tokens)

Set up “Shipping and cancellation updates”

Sets up Cosend’s “Shipping and cancellation updates” automation on one WhatsApp number: Customers get a WhatsApp message with their tracking when an order ships, and another if it is cancelled. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. It needs woocommerce connected to the workspace first (by integration key). Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_lead_capture` (~362 tokens)

Set up “Lead capture from ads”

Sets up Cosend’s “Lead capture from ads” automation on one WhatsApp number: People who message you from an ad answer your questions one at a time, and you get their answers. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_quote_intake` (~359 tokens)

Set up “Quote requests”

Sets up Cosend’s “Quote requests” automation on one WhatsApp number: Customers who ask for a quote answer your questions, then the chat comes to you with their answers. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_appointment_reminder` (~388 tokens)

Set up “Appointment reminder”

Sets up Cosend’s “Appointment reminder” automation on one WhatsApp number: Customers get a reminder before each booking, and you choose what Confirm, Reschedule and a typed reply do. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. It needs google_calendar or microsoft_calendar or calendly or cal_com or bokun connected to the workspace first (by integration key). Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_welcome_menu` (~364 tokens)

Set up “Welcome and away menu”

Sets up Cosend’s “Welcome and away menu” automation on one WhatsApp number: Greets new customers, and anyone who writes while you are closed, with buttons for quick answers or a person. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_payment_reminder` (~377 tokens)

Set up “Payment reminder”

Sets up Cosend’s “Payment reminder” automation on one WhatsApp number: Customers get WhatsApp reminders before and after an invoice in your Google Sheet is due, until you mark it paid. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. It needs google_sheets connected to the workspace first (by integration key). Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_review_request` (~360 tokens)

Set up “Review request”

Sets up Cosend’s “Review request” automation on one WhatsApp number: Tag a customer when the job is done, and a few hours later they get your request for a review. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_missed_call_text_back` (~366 tokens)

Set up “Missed call text-back”

Sets up Cosend’s “Missed call text-back” automation on one WhatsApp number: When a customer calls your WhatsApp number and nobody picks up, they get a message from you straight away. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `set_up_accurate_warehouse_arrival` (~381 tokens)

Set up “Warehouse arrival message”

Sets up Cosend’s “Warehouse arrival message” automation on one WhatsApp number: When an Accurate shipment reaches the warehouse, its receiver gets one WhatsApp message with the shipment’s details. Its settings are this recipe’s own, as its set-up form in Cosend asks them; a setting left out takes its default. It is set up switched off, and acts only once it is switched on. The same recipe is set up once on each number, or once per source when it asks for one. The preview refuses a second one as the save would, and gives no token. It needs accurate, and http connected to the workspace first (by integration key). Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the automation, switched off.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string, required): The WhatsApp number (connection id) this automation belongs to: its triggers come from it, its messages go from it, and its templates are read on it. Required, and it cannot be moved afterwards. The…
- `name` (string): Its name in Cosend. Left out, it takes the recipe’s name.
- `settings` (object, required): The recipe’s settings, as its set-up form asks them. A setting left out takes its default; a setting with no default is needed.

### `update_ai_receptionist` (~271 tokens)

Change “AI receptionist” settings

Changes the settings of an automation set up from Cosend’s “AI receptionist” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “AI receptionist” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_order_confirmation` (~269 tokens)

Change “Order confirmation” settings

Changes the settings of an automation set up from Cosend’s “Order confirmation” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Order confirmation” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_order_updates` (~273 tokens)

Change “Shipping and cancellation updates” settings

Changes the settings of an automation set up from Cosend’s “Shipping and cancellation updates” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Shipping and cancellation updates” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_lead_capture` (~274 tokens)

Change “Lead capture from ads” settings

Changes the settings of an automation set up from Cosend’s “Lead capture from ads” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Lead capture from ads” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_quote_intake` (~270 tokens)

Change “Quote requests” settings

Changes the settings of an automation set up from Cosend’s “Quote requests” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Quote requests” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_appointment_reminder` (~271 tokens)

Change “Appointment reminder” settings

Changes the settings of an automation set up from Cosend’s “Appointment reminder” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Appointment reminder” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_welcome_menu` (~274 tokens)

Change “Welcome and away menu” settings

Changes the settings of an automation set up from Cosend’s “Welcome and away menu” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Welcome and away menu” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_payment_reminder` (~270 tokens)

Change “Payment reminder” settings

Changes the settings of an automation set up from Cosend’s “Payment reminder” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Payment reminder” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_review_request` (~269 tokens)

Change “Review request” settings

Changes the settings of an automation set up from Cosend’s “Review request” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Review request” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_missed_call_text_back` (~278 tokens)

Change “Missed call text-back” settings

Changes the settings of an automation set up from Cosend’s “Missed call text-back” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Missed call text-back” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `update_accurate_warehouse_arrival` (~276 tokens)

Change “Warehouse arrival message” settings

Changes the settings of an automation set up from Cosend’s “Warehouse arrival message” recipe, named by id, as its settings page in Cosend does: the settings given replace their values, the rest keep theirs, and the result is saved as a new version. If the automation is switched on, the new settings go live with the save, or the save is refused in words and it keeps running what it ran; if it is off, they wait for it to be switched on. An automation from another recipe, or one written by hand, is refused. Each call needs confirming: without confirmation_token it changes nothing and returns a preview with the settings as Cosend filled them in and its check of them, and a token for a person to approve; called again with that token, it saves. Returns the new version.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation set up from the “Warehouse arrival message” recipe whose settings change.
- `settings` (object, required): The settings to change, as the recipe’s settings form asks them. A setting left out keeps the value it has.

### `list_runs` (~131 tokens)

List automation runs

Lists automation runs, newest first, one page at a time, with each run’s status, how long it took and what it sent. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `automation_id` (string): Only runs of this automation.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `status` (string): Only runs in this state: queued, running, waiting, success, failure, cancelled, timeout, skipped or unknown.

### `get_run` (~139 tokens)

Read an automation run

Reads one automation run and its step-by-step trace: under run, the run’s status, timings, what it sent and why it failed; under steps, each step it took with its status and error, one page at a time. Text inside a run can quote what a customer wrote, and comes back marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `id` (string, required): The id in the resource path.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `get_usage` (~43 tokens)

See plan usage

Reports this workspace’s usage for one billing period against what its plan includes. Read-only.

Input parameters:

- `period` (string): Which billing period. Omit for the current one.

### `resolve_conversation` (~152 tokens)

Mark a conversation Done

Marks one conversation Done, as the Done button in the Cosend Inbox does. Nothing is sent to anyone and no automation starts. Afterwards no person holds the conversation (the person, the assignee, the priority and any hand-over are cleared) and every automation on that WhatsApp number treats the customer’s next message as a first message: the welcome menu greets again, an unfinished question flow starts over, and the AI assistant begins a new AI conversation, which counts as one more AI conversation on the plan. The message history stays. The chat stays quiet until the customer writes again. It is refused for a credential with no person behind it.

Input parameters:

- `id` (string, required): The id in the resource path.

### `create_setup_link` (~425 tokens)

Make a set-up link

Makes a link for the person in this chat to open in their own browser, signed in to Cosend, to do one set-up step only they can do there, and returns its url. It works for 30 minutes and only for them, and carries no password or key. kind connect_number connects a WhatsApp number; reconnect_number needs connection_id and runs Meta’s flow again for that number; connect_integrations needs connectors (each integration by its Cosend key, as list_connectors gives them) and completes when every one has an account, and with account_id (and that account’s one connector) the person types a new key for an account that already exists; pick_google_file needs account_id, a Google account, and opens Google’s file picker for it so the person can choose spreadsheets Cosend may open; upgrade needs plan, the plan to buy; payment_method adds a card. The person does the step themselves on the page: they connect the number in Meta’s window, sign in to the integration or type its key, choose files in Google’s picker, pay in Stripe’s Checkout, or add the card. It cannot be done for them. A new link of the same kind cancels the workspace’s open one, whoever made it.

Input parameters:

- `account_id` (string): The connected Google account whose file picker opens, by its connector account id. The person chooses the spreadsheets Cosend may open; the link completes when the picker was opened.
- `connection_id` (string): The WhatsApp number to reconnect, by its connection id. The person runs Meta’s flow again for it, and the link completes when that number is connected.
- `connectors` (array): The integrations the person signs in to, by key from GET /v1/connectors. The link completes when every one of them has an account.
- `kind` (string, required)
- `plan` (string): The plan to buy, by code from GET /v1/billing/plans. Only for a workspace with no paid subscription, and only to a higher plan.

### `check_setup_link` (~184 tokens)

Check a set-up link

Reads a set-up link’s status. status open means the step is not done; completed means it has, and result says what was set up; expired means its 30 minutes passed; cancelled means it was cancelled or replaced by a newer one. For connect_integrations, result.connector_accounts lists each account saved; when the workspace has several WhatsApp numbers an account is on none of them until it is added to a number (the Integrations page in Cosend, or the integration account tool’s add_number). For reconnect_number, result names the connection and its number once Meta’s flow finished; for pick_google_file, completed means Google’s picker was opened for the account, and the account’s spreadsheet list shows what was chosen. Only the person who asked for the link can read it. Read-only.

Input parameters:

- `id` (string, required): The id in the resource path.

### `cancel_setup_link` (~83 tokens)

Cancel a set-up link

Cancels an open set-up link so its page stops working, for example when the person changed their mind or the link asks for the wrong thing. A link already completed, expired or cancelled is refused, and nothing a link set up is undone. Only the person who asked for it can cancel it.

Input parameters:

- `id` (string, required): The id in the resource path.

### `whatsapp_link` (~240 tokens)

Make a WhatsApp chat link

Makes a wa.me chat link and its QR code (an SVG image) for a WhatsApp number, with an opening message if one is given. country is the two-letter ISO code and number is the number exactly as it is typed in that country (as written at home, with +, with 00 or with the country code in front); a number of another country is refused. It sends nothing to anyone.

Input parameters:

- `country` (string, required): The country the number belongs to, as its two-letter ISO code: "GB", "US", "DE". A number of another country is refused.
- `message` (string): The message the chat starts with, at most 500 characters. Left out or blank, the link opens an empty chat.
- `number` (string, required): The WhatsApp number as people type it: as written at home (07700 900123), with + (+44 7700 900123), with 00 (0044 7700 900123) or with the country code in front (44 7700 900123). Spaces, dashes, brac…

### `template_check` (~426 tokens)

Check a template before Meta reviews it

Checks a WhatsApp message template (category, language, components and example values, as Meta takes them) against Meta’s rules, which are errors, and the warning signals Meta names, which are warnings; each problem says where it is and what to change. The verdict is fix_first, warnings or ready, and ready is not an approval: Meta still reviews every template itself. Nothing is submitted.

Input parameters:

- `authentication`: An authentication template, in Meta's shape, in place of components and language: {"languages": ["fr", "en_US"], "add_security_recommendation": true, "code_expiration_minutes": 10, "delivery": {"type…
- `category` (string, required)
- `components` (array): Meta's components, as POST /v1/templates takes them; required on every category but authentication, which takes authentication instead.
- `example_values` (object): A sample value for every variable in the TEXT header and the body, keyed per component by the name between the braces: {"body": {"1": "Pablo", "2": "860198-230332"}} or {"body": {"first_name": "Pablo…
- `language` (string): The language, e.g. "en_US". Required on every category but authentication, which takes authentication.languages instead.
- `parameter_format` (string)

### `message_cost` (~130 tokens)

See what a WhatsApp message costs

Returns Meta’s list price for one delivered WhatsApp message in a country, for each category (marketing, utility, authentication, service), in one of Meta’s 16 rate-card currencies, with the day the rates took effect. These are Meta’s list prices: a business’s bill may differ, and the notes say what changes it.

Input parameters:

- `country` (string, required): The country the messages go to, as its two-letter ISO code, e.g. GB or DE.
- `currency` (string, required): One of Meta’s 16 rate-card currencies, e.g. USD, EUR, GBP or INR.

### `get_conversation` (~256 tokens)

Open a conversation

Reads one conversation, named by id. view conversation returns the chat itself: its contact and newest message, its state, who it is assigned to, its labels, priority and snooze, the hand-over summary when a person is needed, who holds the reply lock, and the 24-hour customer service window (open or closed, and when it closes). view activity returns the chat’s activity feed one page at a time: hand-overs, assignments, labels, Done and reopened, optionally only the kinds named in kind. Names, message text and hand-over summaries were written by people outside this business, or from what they wrote, and come back marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `id` (string, required): The id in the resource path.
- `kind` (array): Activity view only: keep only these kinds of activity. Repeat for several.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `view` (string, required): conversation for the chat itself, with its window and who holds it; activity for its activity feed.

### `search_messages` (~177 tokens)

Search message text

Searches the text of every message in the workspace, newest first, 20 hits to a page. Each hit has the message id, the conversation id and number it belongs to, when it was sent and a snippet of the matching text. A number whose messages go straight to the business’s own system, with no Cosend inbox, is left out. Snippets were written by people outside this business and come back marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `connection_id` (string): Only messages on this WhatsApp number.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `q` (string, required): The words to look for in message text.

### `get_message` (~92 tokens)

Open one message

Reads one message, named by its msg_ id or by the WhatsApp message id (wamid): its type and content, direction, delivery status with the time of each step, who sent it, and any file, location, buttons or reactions it carries. Message text comes from people outside this business and comes back marked untrusted. Read-only.

Input parameters:

- `id` (string, required): The id in the resource path.

### `get_media` (~83 tokens)

Open a file from a chat

Reads one media file, named by its med_ id (a message’s media block carries it): its type, file name, size and state, and a signed link to download it that works for 15 minutes. File names come from people outside this business and come back marked untrusted. Read-only.

Input parameters:

- `id` (string, required): The id in the resource path.

### `get_inbox_overview` (~251 tokens)

See the Inbox at a glance

Reads the figures the Inbox and Home show, one part at a time. part counts returns how many chats are waiting for a person, assigned to the caller, unread, in all (Done and snoozed ones included), and have a 24-hour window closing within four hours, per number and in total, with the approvals waiting. part labels returns each label in use on each number with how many open chats carry it. part today returns today’s replies by who sent them (the assistant, people, the phone, automations) and the chats handed to a person, marked Done and opened, and the AI receptionist’s chats (handled, answered alone, handed over, as its page and Reports count them), in the workspace’s time zone. part week returns replies and new chats for each of the last 7 days. Read-only.

Input parameters:

- `connection_id` (array): Only this WhatsApp number; repeat it for several. Omit for every number you can see.
- `part` (string, required): counts for chats waiting, mine, unread and windows closing; labels for the labels in use; today for today’s replies by who sent them; week for the last 7 days.

### `mark_read` (~172 tokens)

Mark chats read

Marks read, in one of three ways, with id naming a conversation (cosend, phone_thread) or a message (phone_message). where cosend clears the chat’s unread state for the whole workspace in Cosend; the customer’s phone stays as it was. where phone_thread tells WhatsApp the newest unread customer message was read, so the customer’s phone shows blue ticks on what they sent. where phone_message does the same for the one message named. The blue ticks reach a real person’s phone and are permanent.

Input parameters:

- `id` (string, required): The id in the resource path.
- `where` (string, required): cosend to mark a chat read in Cosend only; phone_thread to show blue ticks for the chat’s unread messages on the customer’s phone; phone_message to show them for one message.

### `update_conversation` (~175 tokens)

Update a conversation

Changes one conversation, named by id, by whichever of these are given: assignee_id (a member’s usr_ id; null takes the assignee off), snoozed_until (a time; null ends the snooze), labels (the whole list of labels, replacing the old one), priority, and state. state resolved marks the chat Done, as the Done button does: nobody holds it afterwards and every automation on that number treats the customer’s next message as a first message. The change stays inside Cosend, out of the customer’s view. Returns the conversation.

Input parameters:

- `assignee_id`
- `id` (string, required): The id in the resource path.
- `labels` (array)
- `priority` (string)
- `snoozed_until`
- `state` (string)

### `bulk_update_conversations` (~238 tokens)

Update many conversations

Applies one action to up to 100 conversations named in ids: resolve marks each Done, assign sets assignee_id (null takes it off), label adds labels_add and takes off labels_remove, priority sets priority, and read marks each read in Cosend. Each chat gets its own result, so one that is not found or that someone else is replying in is skipped with its reason while the rest go through. Each action needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it acts. Every change stays inside Cosend, out of customers’ view.

Input parameters:

- `action` (string, required)
- `assignee_id`
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `ids` (array, required)
- `labels_add` (array)
- `labels_remove` (array)
- `priority` (string)
- `read` (boolean)

### `take_over_conversation` (~146 tokens)

Hand a chat to a person

Puts one conversation, named by id, in a person’s hands: control human means a person holds it and the AI assistant and automations stop answering in it; control pending_human marks it as waiting for a person to pick up. reason says why, and pause_bot_until holds the assistant back until a time. It hands the chat to a person; the chat stays with people from then on. The change stays inside Cosend, out of the customer’s view. Returns the conversation.

Input parameters:

- `control` (string, required)
- `id` (string, required): The id in the resource path.
- `pause_bot_until` (string)
- `reason` (string)

### `ask_for_conversation` (~238 tokens)

Ask a teammate for a chat

Asks the person who holds one conversation, named by id, in the Cosend Inbox to hand it over; reason is an optional note for them. They get a hand-over prompt: when they say yes, or do not answer within 60 seconds, the chat passes to the person this app acts for, and messages can be sent in it; when they say no, it stays theirs. This is the way into a chat someone else holds: every hand-over starts with asking its holder. A chat nobody holds, or one the person this app acts for already holds, is refused, as there is nothing to ask for and a message can be sent there as it is. Asking again while a request waits returns that request. Returns the request: its state (pending until answered), who holds the chat (held_by) and when it passes without an answer (expires_at). Whether it has passed shows in the conversation’s lock (held_by, can_i_send). The request stays inside Cosend, out of the customer’s view.

Input parameters:

- `id` (string, required): The conversation to ask for.
- `reason` (string)

### `list_chat_notes` (~133 tokens)

Read the internal notes on a chat

Lists the internal notes on one conversation, named by id, one page at a time, oldest first: each note’s body, its author, the members it mentions and when it was written or edited. The customer does not see notes. Notes can quote customers and come back marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `id` (string, required): The id in the resource path.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `chat_notes` (~240 tokens)

Add, edit or delete an internal note

Writes the internal notes on one conversation, named by id, visible to the business’s team. action add writes a note (body, with mentions as a list of usr_ ids of members to notify). action edit changes a note’s body (noteId and body; only its author can). action delete removes a note (noteId; its author, an owner or an admin can). Each delete needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it deletes. add and edit return the note, whose body can quote customers and comes back marked untrusted.

Input parameters:

- `action` (string, required): add, edit or delete.
- `body` (string)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The id in the resource path.
- `mentions` (array)
- `noteId` (string): The noteId in the resource path.

### `list_inbox_views` (~52 tokens)

Read the saved Inbox views

Lists the saved views in the Inbox’s Views menu: the caller’s own views and every one shared with the workspace, each with its name, the conversation filters it applies and who sees it. Read-only.

### `inbox_views` (~220 tokens)

Save, change or delete an Inbox view

Writes the saved views in the Inbox’s Views menu: a name and the conversation filters it applies. action save makes a view (name, filters, and shared: private or workspace). action update (id) renames a view or changes its filters or who sees it; a shared view can be changed by its creator, an owner or an admin. action delete (id) removes a view, on the same terms. Each delete needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it deletes.

Input parameters:

- `action` (string, required): save, update or delete.
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `filters` (object)
- `id` (string): The id in the resource path.
- `name` (string)
- `shared` (string)

### `get_contact` (~220 tokens)

Open a contact

Reads one contact, named by id (a ct_ id, an E.164 phone number or a BSUID), in one of four views. view contact returns the contact: names, phone number or BSUID, tags, attributes, time zone and whether it is blocked. view consent returns the consent state for marketing, utility and authentication, with the entry behind each (where it came from, when, who recorded it, the sentence the person agreed to) and Meta’s own marketing opt-out. view window returns whether a free-form message can be sent now and when the 24-hour customer service window closes. view chats returns this person’s conversation on each number you can see, newest first. Names, attributes and consent sentences come from outside this business and come back marked untrusted. Read-only.

Input parameters:

- `id` (string, required): The id in the resource path.
- `view` (string, required): contact for the contact itself; consent for consent per category with its evidence; window for the messaging window; chats for this person’s chats on each number.

### `update_contact` (~335 tokens)

Edit a contact

Changes one contact, named by id, by whichever of these are given: name (the name the business sets, which shows first; null goes back to the WhatsApp names; owners and admins only), attributes (field values by key), tags (the whole list, replacing the old one), locale, timezone, and is_blocked (true blocks the contact on their number so nothing is sent to them and their messages are not answered; false unblocks; owners and admins only). The change stays inside Cosend, out of the contact’s view. Returns the contact.

Input parameters:

- `attributes` (object): Free-form values. PATCH replaces them whole; a POST for a contact that already exists writes the keys sent over its values and removes none. A key registered in /v1/contact-fields must hold a value o…
- `connection_id` (string)
- `id` (string, required): The id in the resource path.
- `is_blocked` (boolean)
- `locale`
- `name`
- `profile_name`
- `tags` (array)
- `timezone`

### `tag_contact` (~114 tokens)

Tag or untag a contact

Adds tags to, or removes tags from, one contact, named by id, without touching the rest of its tags. action add leaves a tag the contact already has as it is; action remove skips a tag it does not have. tags is the list of tag names. The change stays inside Cosend. Returns the contact.

Input parameters:

- `action` (string, required): add to put tags on the contact, remove to take them off.
- `id` (string, required): The id in the resource path.
- `tags` (array, required)

### `delete_contact` (~242 tokens)

Delete a contact

Deletes one contact, named by id. Without purge the contact and its chats drop out of lists, counts and the Inbox, and Cosend keeps their messages until a purge; if the person writes again, they become a new contact with a new chat. With purge true the contact and what Cosend holds about them are erased for good (an owner’s action, for a data-protection request). The deletion stays inside Cosend, out of the contact’s view. Each delete needs a confirmed call: without confirmation_token the call is a preview that names the contact and returns a token for a person to approve; called again with that token, it deletes.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The id in the resource path.
- `purge` (boolean): true to erase the contact for good, as a data-protection erasure does (owners only); omit to take the contact and its chats out of lists and the Inbox, with its messages kept.

### `merge_contacts` (~157 tokens)

Merge two contacts

Merges two identities of one person (a phone number and a BSUID): the contact named by id keeps going, and the one named by from is folded into it and removed. It cannot be undone. Each merge needs a confirmed call: without confirmation_token the call is a preview that names both contacts and returns a token for a person to approve; called again with that token, it merges. Returns the contact that remains.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `from` (string, required)
- `id` (string, required): The id in the resource path.

### `list_contact_fields` (~120 tokens)

Read the contact fields

Lists the workspace’s contact fields, the keys a contact’s attributes can hold, one page at a time: each field’s key, label, type (text, number, date, boolean or choice), its choices, whether it is required, and how many contacts hold a value for it. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `contact_fields` (~260 tokens)

Add, change or delete a contact field

Writes the workspace’s contact fields: the keys a contact’s attributes can hold. action create adds one (key, label, type text, number, date, boolean or choice, choices for a choice field, required). action update (id) changes a field’s label, type, choices or required; its key stays. action delete (id) removes the field and every contact’s value for it. Creating, changing and deleting are for owners and admins. Each delete needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it deletes.

Input parameters:

- `action` (string, required): create, update or delete.
- `choices` (array): A choice field's options, 1 to 100 of them, each once; none otherwise.
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string): The id in the resource path.
- `key` (string)
- `label` (string)
- `required` (boolean)
- `type` (string)

### `import_contacts` (~534 tokens)

Import contacts from a CSV

Imports contacts from a CSV file for one WhatsApp number, in steps. step start uploads the file (connection_id; data_base64, or media_id of a text or CSV file already uploaded; file_name) and returns its id, columns, first rows and row count. step map (id) sets mapping (each column as phone, name, tags, locale, timezone, skip or field:key; name and tags may be on several columns), new_fields (fields the run adds to the workspace, each key, label, type and choices, for columns mapped to field:key), connection_id, and consent: the opt-in categories everyone in the file gave, the sentence they agreed to and who attests it. step check (id) reports what a run would do over the whole file: new, updated, invalid, duplicates, already opted out and consent recorded, and with details true the rows left out and five contacts as they will be (a phone typed without its country code takes the country of the number); it writes nothing. step run (id) imports in the background and returns at once; the import’s progress shows in the list of imports. Owners and admins run imports. Each run needs a confirmed call: without confirmation_token the call is a preview that shows the import, its mapping, its new fields and its consent, and returns a token for a person to approve; called again with that token, it runs. The import stays inside Cosend, out of the contacts’ view. File contents come from outside this business and come back marked untrusted.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string)
- `consent`
- `data_base64` (string): The CSV file, base64-encoded.
- `details` (boolean): Also answer the rows that will not be imported (the first 100) and five contacts as the import will write them.
- `file_name` (string)
- `id` (string): The id in the resource path.
- `mapping` (object)
- `media_id` (string): A med_ id from POST /v1/media (text/plain or text/csv), instead of data_base64.
- `new_fields` (array)
- `step` (string, required): start to upload the file; map to set the columns, the number and the consent; check to see what a run would do; run to import.

### `list_contact_imports` (~168 tokens)

See contact imports

Reads contact imports. Without id it lists the workspace’s imports, newest first, one page at a time (a member sees those for their own numbers). With id it returns that import: its state (draft, queued, running, completed or failed), the file, columns, mapping and consent, progress, and when finished the number imported and the rows that failed with the reason for each. File contents come from outside this business and come back marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `id` (string): The id in the resource path.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `list_numbers` (~137 tokens)

List WhatsApp numbers

Lists the WhatsApp numbers connected to this workspace, one page at a time, each with its id, status and health at a glance. The number ids it returns are what other tools take as connection_id. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `mode` (string): Only numbers connected this way: coexistence or cloud_api.
- `status` (string): Only numbers in this state, e.g. active.

### `get_number` (~168 tokens)

Read one WhatsApp number

Reads one WhatsApp number in one of four views. summary: its status, quality, limits and onboarding summary. import_progress: the progress of importing the number’s chat history. connect_steps and attempt_steps: an ordered list of the steps of connecting it, each with its state, time and outcome, which explains where a connect that stopped stopped. Read-only.

Input parameters:

- `id` (string, required): The WhatsApp number (connection) id; for view attempt_steps, the connect attempt id.
- `view` (string, required): summary for the number with its onboarding summary; import_progress for how far the chat-history import has come; connect_steps for the steps of how the number was connected, with their times and out…

### `list_cosend_numbers` (~272 tokens)

List phone numbers from Cosend

Reads the phone numbers from Cosend (bought through Cosend for WhatsApp) in one of two views. held: the numbers this workspace holds now or gave back in the last 12 months, with how many count toward the plan’s limit. Each has its id (cnm_…), its status (buying, verifying while WhatsApp’s code is awaited, ready, stopping until its last day in release_at, released), and whether WhatsApp pre-verified it; when it did not, preverify_error says why and preverify_retry_at says from when Cosend may ask WhatsApp for a new code on the same number. available: up to 10 local US or Canadian numbers that can be bought now, each with its phone_number, country, locality and region, which a purchase names exactly; owners and admins only. Read-only.

Input parameters:

- `area_code` (string): For view available: a three-digit area code.
- `contains` (string): For view available: 2 to 7 digits the number should contain.
- `country` (string): For view available: US or CA.
- `view` (string, required): held for the numbers this workspace has from Cosend; available for local numbers Cosend can get for it now, by country, area code and digits.

### `buy_cosend_number` (~339 tokens)

Buy a phone number from Cosend

Buys one local US or Canadian phone number from Cosend for WhatsApp, named by its phone_number and country as the search of available numbers returned them (with its locality and region), and returns it as a Cosend number (cnm_…), usually verifying. It charges the workspace’s card, so it acts only on a confirmed call: without confirmation_token it buys nothing and returns a preview and a token for a person to approve. The preview shows the price of a number, its interval (month or year, as the plan is billed), when it renews and the amount charged today for the rest of the billing period; the price, interval and renewal are read again when the token comes back, and if any changed the token is refused. Changing a single character of the arguments invalidates the token too. Only a person’s approval buys it: the credential alone buys nothing, through this tool or straight to the API. On a paid plan with a card on file, for owners and admins, up to the plan’s number limit; five a minute and ten a day per workspace. The number is on the Numbers page of the Cosend dashboard too.

Input parameters:

- `category` (string, required)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `country` (string, required)
- `display_name` (string, required)
- `locality` (string)
- `phone_number` (string, required)
- `region` (string)
- `website` (string)

### `stop_cosend_number` (~219 tokens)

Stop using a phone number from Cosend

Stops a phone number from Cosend, named by id (cnm_…), that is verifying or ready, and returns it stopping, with release_at, its last day: an hour before the billing period ends. On that day any WhatsApp connection on it is disconnected and the number is given back for good; nothing is refunded, and nothing more is billed for it. It acts only on a confirmed call: without confirmation_token it changes nothing and returns a preview of the number and a token for a person to approve; the number’s status, last day and WhatsApp connection are read again when the token comes back. Only a person’s approval stops it. Owners and admins; a workspace with an unpaid invoice may stop one too.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The Cosend number (cnm_…) to stop.

### `keep_cosend_number` (~220 tokens)

Keep a stopped phone number from Cosend

Keeps a phone number from Cosend that was stopped, named by id (cnm_…), before its last day (release_at), and returns it ready: it is not given back, and from the plan’s next renewal it is billed with the plan again, at $5.95 a month, or $59.50 a year when the plan is billed yearly. Nothing is charged today. It acts only on a confirmed call: without confirmation_token it changes nothing and returns a preview of the number and a token for a person to approve; the number’s status, last day and WhatsApp connection are read again when the token comes back. Only a person’s approval keeps it. On a paid plan, for owners and admins.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The stopped Cosend number (cnm_…) to keep.

### `list_connectors` (~54 tokens)

List what can be connected

Lists the integrations Cosend can connect, each by its Cosend key, with how it signs in and which of its accounts this workspace already has. The key is what a set-up link for integrations takes. Read-only.

### `get_integration_accounts` (~212 tokens)

See connected integration accounts

Lists the workspace’s connected integration accounts, one page at a time, or reads one when id is given. Each has its integration, name, status, the WhatsApp numbers it is used on and the reason it last failed, if it did. Credentials stay sealed in Cosend. Labels and error text come from the provider and are marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `connection_id` (string): Only the accounts used on this WhatsApp number.
- `connector` (string): Only accounts of this integration, by its Cosend key.
- `id` (string): One integration account to read. Left out, the accounts are listed.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `status` (string): Only accounts in this state: active, needs_reauth, error, disabled or revoked.

### `list_google_logins` (~79 tokens)

List connected Google logins

Lists the Google logins connected to this workspace, each with its status and the integrations (Sheets, Calendar, Gmail) it serves. Credentials stay sealed in Cosend. Each login’s label is the address Google shows and comes back marked untrusted. Read-only.

Input parameters:

- `connection_id` (string): Only the logins used on this number.

### `get_setup_guide` (~52 tokens)

Read the set-up guide

Returns the workspace’s set-up guide: each step with its state, done, to do or skipped, worked out from what the workspace already has. It shows what is left to set up. Read-only.

### `get_template` (~82 tokens)

Read one template

Reads one message template: its components, category, language, Meta’s review status, whether it can be sent right now and, for a rejected one, Meta’s reason in Meta’s own words (marked untrusted). Read-only.

Input parameters:

- `id` (string, required): The template: its tpl_ id, or name:language (for example order_update:en_US).

### `change_template` (~640 tokens)

Edit, copy or delete a template

Changes an existing message template at Meta. action edit replaces all of its components and returns it to review (an approved template can be edited once in 24 hours); copy creates it on another WhatsApp account of the same business, where Meta reviews it again; delete removes it at Meta and from Cosend once Meta confirms. Each change needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it acts. Ten changes a day per workspace. It sends no message to anyone. Meta’s reason for a refusal is in Meta’s words.

Input parameters:

- `action` (string, required): edit replaces the template’s components and sends it back to Meta’s review; copy makes a copy of it on another WhatsApp account of the business; delete removes it at Meta.
- `authentication`: An authentication template's choices, as create takes them. An edit is one language version: languages is left out, or exactly the template's own language.
- `category` (string): A new category, sent to Meta when it differs. Meta refuses a change on an approved template, so that is refused here first.
- `components` (array): Meta's components, all of them; required on every category but authentication, which takes authentication instead.
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `display_name` (string): A new human name for the copy, from which its system name is made (with _2, _3… added when the account already has that name). Without it the copy keeps the template’s names, and an account that alre…
- `example_values` (object): A sample value for every variable in the TEXT header and the body, keyed per component by the name between the braces: {"body": {"1": "Pablo", "2": "860198-230332"}} or {"body": {"first_name": "Pablo…
- `id` (string, required): The template: its tpl_ id, or name:language.
- `language` (string): The template's language, which an edit keeps. Send the template's own language, or leave it out.
- `name` (string): The template's system name, which an edit keeps. Send the template's own name, or leave it out.
- `parameter_format` (string)
- `waba_id` (string): The WhatsApp Business Account to copy to, as Cosend's wab_ id (a connection's waba_id, not its meta_waba_id). It must be another account of the same business portfolio.

### `sync_templates` (~69 tokens)

Refresh templates from Meta

Reads the templates of one WhatsApp number from Meta now, updates what Cosend holds to match, and returns the synced list. connection_id is the number. Templates Meta changed since the last sync, such as a decision or a new category, show up here.

Input parameters:

- `connection_id` (string, required)

### `list_template_category_changes` (~51 tokens)

See template category changes

Meta sometimes moves a template to another category, which changes its price. Lists every such change Meta made or announced that nobody in the workspace has acknowledged, on the numbers the caller can see. Read-only.

### `acknowledge_category_change` (~68 tokens)

Acknowledge a template category change

Marks one template category change, named by id, as seen for the whole workspace, so it leaves the list of open changes. It changes nothing about the template, and nothing is sent to Meta.

Input parameters:

- `id` (string, required): The category change to acknowledge, from the list of category changes.

### `get_automation` (~222 tokens)

Read one automation

Reads one automation in one of three views. details: its name, status, number, the live version, what it clashes with while it is on and, on request, its versions and recipe settings. versions: every version, newest first, one page at a time. stats: the chats it answered alone and handed over, by day, with the top hand-over reasons. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `expand` (string): Comma-separated extras for view details: active_version, latest_version, ir, settings.
- `id` (string, required): The automation id.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `range` (string): For view stats: today or 7d. Defaults to today.
- `view` (string, required): details for the automation itself; versions for every version, newest first; stats for how it did today or over seven days.

### `update_automation_details` (~146 tokens)

Rename an automation

Changes an existing automation’s name or description, and nothing else: what it does and its settings stay as they are. connection_id puts an automation made before numbers, which runs on every number, on one WhatsApp number, once; one that has a number keeps it. Returns the automation.

Input parameters:

- `connection_id`: The WhatsApp number for an automation that has none and runs on every number. Accepted once; an automation that has a number keeps it, and another one (or null) is refused. The value it already has,…
- `description`
- `id` (string, required): The automation id.
- `name` (string)

### `copy_automation` (~112 tokens)

Copy an automation

Makes a custom copy of an existing automation, a recipe’s included, on the same WhatsApp number and switched off, with its own copy of the persona, knowledge and remembered values. name is the copy’s; left out, it is the original’s followed by “(copy)”. The original is unchanged. Returns the copy.

Input parameters:

- `id` (string, required): The automation to copy.
- `name` (string): The copy’s name. Absent: the original’s, followed by “(copy)”.

### `rollback_automation` (~172 tokens)

Roll an automation back

Points an existing automation back at an earlier version, named by its number (to_version). A version not yet ready to run is got ready first; one that cannot be is refused, and the live version stays. Its steps do not change; if the automation is switched on, it runs that version from then on. Each call needs confirming: without confirmation_token it changes nothing and returns a preview and a token for a person to approve; called again with that token, it rolls back. Returns the automation.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation id.
- `to_version` (integer, required)

### `delete_automation` (~131 tokens)

Delete an automation

Deletes an automation. One that is switched on is switched off with it, no run starts after it, it leaves the list of automations, and its id stops answering. Each call needs confirming: without confirmation_token it changes nothing and returns a preview and a token for a person to approve; called again with that token, it deletes.

Input parameters:

- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The automation to delete.

### `test_automation` (~188 tokens)

Test an automation on a sample customer

Runs the newest version of an automation once on a sample customer as a dry run: each step is recorded as what it would have done, and every message stays inside the test. payload lays trigger fields over the sample; fail_step runs the error branch as if that step had failed. Returns the run, whose steps are read through the run tools. It uses one automation run if it starts. A version that cannot be tested is refused in words.

Input parameters:

- `fail_step` (string): Optional. The id of a step: the test runs the error branch as if that step had failed, and shows what the branch would do. Refused when the automation has no error branch or no such step.
- `id` (string, required): The automation id.
- `payload` (object): Optional. Trigger subtrees (`message`, `order`, …) laid over the sample's, field by field.

### `run_automation` (~310 tokens)

Start an automation by hand

Starts one run of a switched-on automation now, as its manual trigger does, with payload as the trigger’s data. It runs the live version, which acts as it was built to and can send WhatsApp messages to customers; those messages are final once sent. actions names every action the live version’s steps take, and those of a second automation set up with it, from the list in the schema (an automation’s versions list theirs as actions); a list that leaves one out or names another is refused, with the right list. The preview refuses that list as the call would, and gives no token. Each start needs confirming: without confirmation_token it changes nothing and returns a preview and a token for a person to approve; called again with that token, it starts the run. Returns the run, which the run tools follow.

Input parameters:

- `actions` (array, required): Every action the automation’s steps take, and those of a second automation set up with it, each once: what a person approves it doing. A list that leaves one out, or names one the steps do not take,…
- `automation_id` (string, required)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `payload` (object)

### `cancel_run` (~54 tokens)

Cancel a run

Cancels a run that has not finished, as a stop: it needs no confirmation. Messages the run already sent stay sent. Returns the run as it is after the cancel.

Input parameters:

- `id` (string, required): The run id.

### `list_automation_recipes` (~138 tokens)

List automation recipes

Lists Cosend’s automation recipes as cards, one page at a time: each one’s slug, name, what it does, its category, the settings it asks for and the integrations it needs. Each recipe is set up with a tool of its own named after its slug. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `connection_id` (string): Marks the recipes that cannot work on this WhatsApp number.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `get_reply_order` (~59 tokens)

See the order a number’s automations answer in

Returns the order in which one WhatsApp number’s automations answer a customer’s message. The order follows from the automations themselves. Read-only.

Input parameters:

- `id` (string, required): The WhatsApp number (connection) id whose automations are ordered.

### `list_members` (~69 tokens)

List workspace members

Lists the people in this workspace and its pending invitations, each with role, status and email, and what the next seat costs. Names are typed by the people themselves and come back marked untrusted. Read-only.

Input parameters:

- `connection_id` (string): Only the people who can see this WhatsApp number.

### `get_billing` (~153 tokens)

Read plan and invoices

Reads the workspace’s billing in one of four views. subscription: plan, status, billing period and whether payment is overdue. plans: the plans it may move to, in order, with prices, allowances, seats and features. invoices: when, how much and whether paid, with Stripe’s own document. invoice: one of them. Paying and changing a card happen on a set-up link. Read-only.

Input parameters:

- `invoiceId` (string): The invoice’s Stripe id, from the invoice list (view invoice).
- `view` (string, required): subscription for the current plan, status and period; plans for the plans this workspace may move to; invoices for every invoice; invoice for one, named by invoiceId.

### `get_report` (~324 tokens)

Read a Reports card

Reads one card of Reports for a period: how fast chats were answered by the AI receptionist and by people (response), what the receptionist answered alone and handed over with the top reasons (receptionist), each number’s chats (numbers), each member’s chats, response times and chats marked Done (team), chats by hour of the day (hours), or each Click-to-WhatsApp ad’s chats, replied to and handed to a person (ads). Owners and admins, on the Starter plan and above. Each card covers the period asked for, from the first day Reports recorded. Hand-over reasons, member names and ad words come back marked untrusted. Read-only.

Input parameters:

- `card` (string, required): response for how fast chats were answered; receptionist for what the AI receptionist handled; numbers for each WhatsApp number; team for each member; hours for chats by hour of the day; ads for each…
- `connection_id` (array): Only this WhatsApp number; repeat it for several.
- `from` (string): A custom period’s first day (YYYY-MM-DD), with to.
- `kind` (string): For card response: first (the default) for each chat’s first answer, every for every answer.
- `period` (string): today, 7d (the default), 30d, or a calendar month as month:YYYY-MM, in the workspace’s time zone. Not with from and to.
- `to` (string): A custom period’s last day (YYYY-MM-DD), with from.

### `get_data_policy` (~36 tokens)

Read how long data is kept

Returns what the workspace keeps, in which group and for how long, and any queued erasure of the whole workspace. Read-only.

### `upload_media` (~378 tokens)

Upload a file

Uploads one file to a WhatsApp number’s media library and returns its media id (med_…), which a message, the number’s profile picture or the AI assistant’s knowledge then takes. The file travels inline as data_base64 with its mime_type, and goes to Meta and to Cosend’s storage in one call. Through an AI app a file is up to 5 MB; a larger video, audio file or document is uploaded in the Cosend dashboard. mime_type decides how WhatsApp sends it: image (jpeg, png), video (mp4, 3gpp), audio (aac, amr, mpeg, mp4, ogg), document (pdf, plain text, Word, Excel and PowerPoint) or sticker (webp). A type WhatsApp does not take, or a file over the limit, is refused before anything is stored. Every upload is its own file on that number, even with the same bytes. The file waits in the media library until a message, the profile or the assistant’s knowledge uses it.

Input parameters:

- `connection_id` (string, required)
- `data_base64` (string, required)
- `filename`
- `mime_type` (string, required): One of the types WhatsApp accepts, which also decides how the file is sent: image (image/jpeg, image/png; 5 MB), video (video/mp4, video/3gpp; 16 MB), audio (audio/aac, audio/amr, audio/mpeg, audio/m…

### `get_assistant_persona` (~108 tokens)

Read the AI assistant’s persona

Reads the persona of one AI assistant, named by id (an automation of this workspace that has an AI step): business name, what the business does, tone, whether it may quote prices, the links it may send and when, the words it avoids, and the confidence threshold below which it hands a chat to a person. An assistant nobody has edited reads as the defaults, with updated_at null. Read-only.

Input parameters:

- `id` (string, required): The id in the resource path.

### `update_assistant_persona` (~246 tokens)

Change the AI assistant’s persona

Changes the persona of one AI assistant, named by id. Only the fields sent change; a list (links, never_say) is the whole new list. The persona is set through typed fields: business_name, what_you_do, tone, may_quote_prices, links, never_say and confidence_threshold. Each change needs a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve; called again with that token, it saves. When the assistant is switched on, customers meet the new persona at their next message. Owners and admins.

Input parameters:

- `business_name` (string)
- `confidence_threshold` (number)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The id in the resource path.
- `links` (array)
- `may_quote_prices` (boolean)
- `never_say` (array)
- `tone` (string)
- `what_you_do` (string)

### `get_knowledge` (~234 tokens)

Read what the AI assistant knows

Reads one AI assistant’s knowledge, named by id. view sources lists every source with its kind (file, text, website, Google place), status (queued, ready, failed), the reason a read failed, the website pages it could not load, and when it was last read; it pages with after and limit. view summary returns what the assistant learned: a short summary, the business name and one-line description read from the material, and suggested questions and answers awaiting a decision. Titles, summaries, questions and answers were read from websites and files by Cosend and come back marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `id` (string, required): The id in the resource path.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `view` (string, required): sources lists the files, pasted texts, websites and Google places the assistant reads. summary reads “what I learned”: a short summary and the suggested questions and answers.

### `change_knowledge` (~386 tokens)

Change what the AI assistant knows

Changes one AI assistant’s knowledge, named by id. action add takes a kind: file (media_id of a file uploaded on the assistant’s number), text (text, with an optional title), url (a website) or place (a Google Maps link); it answers at once with the source, and the assistant reads it in the background (a website is read again every month). action remove (sourceId) forgets a source and everything read from it, on a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve. action refresh (sourceId) reads a source again now. action review_suggestion (suggestionId, accepted true or false, optional question and answer edits) turns a suggested answer into knowledge or drops it. Owners and admins.

Input parameters:

- `accepted` (boolean)
- `action` (string, required): add gives the assistant something to read. remove forgets one source. refresh reads one source again. review_suggestion accepts (with edits) or rejects a suggested answer.
- `answer` (string)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `id` (string, required): The id in the resource path.
- `kind` (string)
- `media_id` (string): A file uploaded on this automation’s number with POST /v1/media. A file uploaded on another number is refused with media_other_number.
- `question` (string)
- `sourceId` (string): The sourceId in the resource path.
- `suggestionId` (string): The suggestionId in the resource path.
- `text` (string)
- `title` (string)
- `url` (string)

### `try_assistant` (~507 tokens)

Try the AI assistant

Asks one AI assistant (automation_id) a customer’s question and returns what it would do: its reply, the intent and confidence it read, the knowledge sources it used, whether it would hand the chat to a person, and the message a customer would receive. The trial stays inside Cosend, out of customers’ view. Each chat is one AI conversation on the plan, counted when the assistant is first asked in it; send the chat_id an answer returns, with history, to continue the same chat. For an assistant that is switched off, connection_id with holding_message (and escalate_keywords or closed hours) tries it with the set-up’s answers. Owners and admins.

Input parameters:

- `automation_id` (string, required): The AI assistant being tried: an automation of this workspace with one AI step. The answer comes from its own persona and knowledge, and from no other assistant’s. Alone, the try also uses the escala…
- `chat_id`: The Try it chat this message continues: the chat_id an earlier answer in it gave. Each chat counts as one AI conversation, billed like a real one, from the first time the assistant is asked in it. Nu…
- `closed` (object): With connection_id: the set-up's closed message, opening hours (HH:MM, in the workspace's timezone) and closed-hours passing message. While closed, the answer's closed_message is the message with the…
- `connection_id` (string): For a receptionist that is not switched on: the number it is being set up on. Requires holding_message; escalate_keywords and closed as the set-up has them. They replace the settings of automation_id…
- `escalate_keywords` (array): With connection_id: the words that pass a chat to a person.
- `history` (array)
- `holding_message` (string): Required with connection_id, and only with it: the message a customer is sent when the assistant cannot answer.
- `message` (string, required)

### `get_business_profile` (~86 tokens)

Read a number’s business profile

Reads the WhatsApp business profile customers see for one number, named by id, from Meta: about, description, address, email, websites, industry and the picture’s address. read_only_reason says when the profile is edited elsewhere (a coexistence number’s is edited in the WhatsApp Business app). Read-only.

Input parameters:

- `id` (string, required): The id in the resource path.

### `update_number` (~496 tokens)

Change a number’s settings or profile

Changes one WhatsApp number, named by id. action settings takes delivery_mode (stored or direct) and override_callback_url (where Meta’s webhooks for the number go; null clears it). action display_name takes display_name and submits it to Meta’s review; Meta’s decision shows on the number later. action profile takes any of about, description, address, email, websites, vertical and profile_picture (a media id from an upload on this number); every customer sees the profile. Each action needs a confirmed call: without confirmation_token the call is a preview that names the number and returns a token for a person to approve. The number’s webhook verify token and relay secret stay sealed in the number’s settings in the Cosend dashboard, and read as null here. Owners and admins.

Input parameters:

- `about` (string)
- `action` (string, required): settings changes how Meta’s messages for the number are handled. display_name submits a new name to Meta’s review. profile edits the business profile customers see.
- `address`
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `delivery_mode` (string)
- `description`
- `display_name` (string)
- `email`
- `id` (string, required): The id in the resource path.
- `override_callback_url`: Your endpoint for Meta’s webhooks for this number. On a `direct` number Cosend sets it as the number’s webhook override at Meta, and Meta sends the number’s messages, echoes, calls and history to it…
- `profile_picture` (object)
- `retention_months`: Retention is set once for the whole account, not per connection. Set it with PATCH /v1/account/data-policy.
- `vertical`
- `websites` (array)

### `manage_number` (~241 tokens)

Refresh or re-check a number

Looks after one WhatsApp number, named by id. action sync refreshes the number’s state, quality rating and limits from Meta and returns the connection. action recheck_payment is for a person who added a payment method in Meta after a number was blocked for payment: it asks Meta again and returns the connection (adding the method itself happens in Meta’s own tools). action retry_verification takes the id of a phone number from Cosend (cnm_…) whose verification stopped, and asks WhatsApp for a new code on that same number, with no new purchase; it is allowed from the number’s preverify_retry_at, and the number shows verifying while Cosend waits up to 10 minutes for the code. Owners and admins for sync and retry_verification. Disconnecting a number is an owner’s or admin’s step in the Cosend dashboard.

Input parameters:

- `action` (string, required): sync reads the number’s state from Meta. recheck_payment asks Meta again after a payment method was added. retry_verification asks WhatsApp again for the code that verifies a phone number from Cosend.
- `id` (string, required): The id in the resource path.

### `read_integration` (~280 tokens)

Look inside an integration account

Reads what one connected integration account holds, named by id. view spreadsheets lists the spreadsheets a Google account can open (the ones Cosend made or a person picked for it), 100 a page at most, or with spreadsheet_id one spreadsheet and its tabs. view forms lists a form account’s forms with the id an automation’s start takes as form_id. view appointments lists a calendar account’s upcoming events from now to days ahead, with the customer number found in each and counts of events with and without one. Names, tab titles and event titles were written by people outside this workspace and come back marked untrusted. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `days` (string): With view appointments: how many days ahead to read, 1 to 30. Default 7.
- `id` (string, required): The id in the resource path.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `spreadsheet_id` (string): With view spreadsheets: read this one spreadsheet and its tabs.
- `view` (string, required): spreadsheets lists a Google account’s spreadsheets, or one spreadsheet’s tabs. forms lists a form account’s forms. appointments previews a calendar’s coming events.

### `manage_integration` (~319 tokens)

Manage an integration account

Manages one connected integration account, named by id; the account returns no credential. action update takes name and config (the account’s non-secret settings). action test makes one safe read at the provider and returns whether the credential works; a failed test is an answer with ok false. action add_number (connection_id) uses the account on another WhatsApp number of the workspace, the same sign-in and not a copy. action remove_number (connection_id) stops using the account on one number, provided the account stays on at least one other number and no switched-on automation there needs it, on a confirmed call: without confirmation_token the call is a preview that returns what would happen and a token for a person to approve. Signing in, and typing or replacing a key, happen on a set-up link the person opens; deleting an account or its saved login is done by a person in the Cosend dashboard. Owners and admins.

Input parameters:

- `action` (string, required): update renames the account or changes its non-secret config. test verifies the credential. add_number and remove_number choose the WhatsApp numbers the account serves.
- `config` (object)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `connection_id` (string): The connection_id in the resource path.
- `id` (string, required): The id in the resource path.
- `name` (string)

### `create_spreadsheet` (~191 tokens)

Make a spreadsheet

Makes a spreadsheet in a connected Google account, named by id: its title, one tab, the header columns (with a type each, text by default) and, optionally, one example row. It lands in the account’s own Google Drive and answers with its id, link, tabs and columns, which an automation’s sheet steps then use. It only creates a new spreadsheet in Google Drive.

Input parameters:

- `columns` (array, required): The header row, first column first: 26 at most, A to Z.
- `example_row` (array): One row under the header for the owner to type over, as wide as `columns`. Absent: the sheet has the header row only.
- `id` (string, required): The id in the resource path.
- `tab` (string, required): The one tab’s name.
- `title` (string, required): The spreadsheet’s name, in the owner’s words.

### `get_approvals` (~225 tokens)

Read approvals

Reads the human-decision queue. view list returns approvals newest first, one page at a time, optionally filtered by state; a member sees the queue of their own numbers. view one returns one approval with exactly what the human is shown (preview) and the arguments of the held action. view action_types returns every action type that can require approval with its default risk. Previews and arguments can quote customers and come back marked untrusted. A person sets the workspace’s mode per type, and decides each approval, in the Cosend dashboard. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `id` (string): The id in the resource path.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `state` (string): With view list: only approvals in this state.
- `view` (string, required): list lists approvals. one reads one approval by id. action_types lists what can need approval.

### `request_approval` (~178 tokens)

Hold an action for a person’s decision

Holds an action for a human decision: action (a type from the approval action types), preview (exactly what the person is shown, up to 4096 characters), arguments, and optionally risk (it can only raise the type’s default) and run_id. The approval is pending, expires 24 hours after it is made (an expiry is a rejection), and appears in the Cosend approvals queue for a person to approve or reject. The workspace’s setting for that action type can also approve or reject it at once, and the answer says which. It only files the request for a person to decide. A retry with the same arguments returns the same approval.

Input parameters:

- `action` (string, required)
- `arguments` (object)
- `preview` (string, required)
- `risk` (string)
- `run_id`

### `list_audiences` (~152 tokens)

List saved audiences for campaigns

Lists the saved audiences of this workspace, one page at a time: each one’s id, name, the WhatsApp number it was saved for, and who it names (contact tags and that number’s chat labels, any or all). A campaign’s audience is one of these. They are saved on the Campaigns page of the Cosend dashboard, or by an AI app, by an owner or an admin; this tool only reads them. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.

### `create_audience` (~119 tokens)

Save an audience for campaigns

Saves an audience for campaigns, with a name, the WhatsApp number it is for and who it names (contact tags and that number’s chat labels, any or all), and returns it with its id, the audience.segment_id a campaign takes. It sends nothing and messages nobody. The audience is on the Campaigns page of the Cosend dashboard too. Campaigns are on the Starter plan and above, and for owners and admins.

Input parameters:

- `connection_id` (string, required)
- `definition` (object, required)
- `name` (string, required)

### `list_campaigns` (~198 tokens)

List campaigns

Lists this workspace’s campaigns, newest first, one page at a time: each one’s id, state (draft, scheduled, sending, paused, sent or stopped), number, template, saved audience, time, quiet hours, and how many it was for, sent, delivered, read, got a reply from and failed for. These are the campaigns on the Campaigns page of the Cosend dashboard. Read-only.

Input parameters:

- `after` (string): The next_cursor of the previous page, to read the page after it. Omit for the first page.
- `connection_id` (array): Only campaigns on this WhatsApp number. Repeat for several.
- `limit` (integer): How many records to return. Defaults to 25, maximum 100.
- `q` (string): Only campaigns whose name contains this.
- `status` (array): Only campaigns in this state, e.g. draft or sending. Repeat for several.

### `get_campaign` (~128 tokens)

Get a campaign and its results

Returns one campaign, named by id, and its results together. The campaign: its state, number, template and the value of each blank, saved audience, time, quiet hours, and why it paused, stopped or could not start. The results: how many it was for, sent, delivered, read, replied, failed, were left out and are still to go, failures by group, sends per 10 minutes and what is left by day. A reply counts for 72 hours after the campaign ends. Read-only.

Input parameters:

- `id` (string, required): The id in the resource path.

### `create_campaign` (~95 tokens)

Start a campaign draft

Starts a campaign as a draft, with a name and the WhatsApp number it goes out on, and returns it with its id. It sends nothing and messages nobody: a draft waits until a person approves it. The draft is on the Campaigns page of the Cosend dashboard too. Campaigns are on the Starter plan and above, and for owners and admins.

Input parameters:

- `connection_id`
- `name` (string)

### `update_campaign` (~365 tokens)

Change a campaign draft

Saves one or more steps of a campaign draft, named by id, and returns it. A step is its name; its number; its template (template_id, a marketing template on that number’s WhatsApp account); the value of each blank (variable_map: a contact field’s key, first_name or name, with fallback text for people who have none, or one text for everyone); what the template shows on top (header: a picture, video or document uploaded to Cosend by its media_id, and the template’s own file when none is chosen; a place by its latitude, longitude, name and address; or the title’s blanks, as variable_map); the value of a link button’s blank and a coupon code (buttons, by the button’s index); its audience, which is a saved audience by its id (audience.segment_id) and nothing else; a time to send it, in a time zone; and its quiet hours, when nothing is sent. Changing the number clears the template and the blanks. A scheduled campaign that is changed is a draft again, and any estimate it had is cleared. It sends nothing.

Input parameters:

- `ab`
- `audience` (object)
- `buttons` (array)
- `cards` (array)
- `connection_id` (string)
- `header`
- `id` (string, required): The id in the resource path.
- `kind` (string)
- `let_join` (boolean)
- `name` (string)
- `quiet_hours` (object)
- `reply_rules` (array)
- `schedule`
- `steps` (array)
- `template_id`
- `track_clicks` (boolean)
- `variable_map` (array)

### `preview_campaign` (~230 tokens)

Check a campaign before it sends

Checks a campaign draft, named by id, and returns what sending it would do, under two keys. audience: how many the saved audience matches, how many get it, how many are left out and why (no WhatsApp number, blocked, opted out on this number, a US number, WhatsApp held back a marketing message to them in the last day, a blank with no value, or a chat open with them now), the first 20 people, and Meta’s list price for one delivered marketing message to each person who gets it, by market, in the WhatsApp account’s currency. estimate: the estimate_id a send names, which lasts 15 minutes; the count; the daily limit and what goes out on which day; the plan’s messages left; and whether the count must be confirmed, which it must above 500. It saves the estimate on the draft and sends nothing. The template must be approved by WhatsApp. Names in the sample were written by the customers themselves and come back marked untrusted.

Input parameters:

- `id` (string, required): The id in the resource path.

### `send_campaign` (~338 tokens)

Send or schedule a campaign

Sends a campaign draft now, or schedules it for its time, named by id, with the estimate_id of a check made in the last 15 minutes; above 500 people, confirm_text is that count. It reaches every person the check counted, on their phones, and the messages cannot be unsent. It sends only on a confirmed call: without confirmation_token it sends nothing and returns a preview and a token for a person to approve. The preview shows the campaign (its number, template and the value of each blank, the file or the place on top, its buttons’ values, saved audience, time and quiet hours) and who gets it now, who is left out and Meta’s list price, all read again when the token comes back: if any of it changed after the preview, the token is refused and a new preview is needed. Changing a single character of the arguments invalidates the token too. Only a person’s approval sends it: the credential alone sends nothing, through this tool or straight to the API. Five a minute and ten a day per workspace. Each campaign is on the Campaigns page of the Cosend dashboard.

Input parameters:

- `confirm_text` (string)
- `confirmation_token` (string): For a call that needs approval: left out, the call does nothing and returns a preview and a token; given that token, with the same arguments, the call does it.
- `estimate_id` (string, required)
- `id` (string, required): The campaign to send.
- `when` (string, required): now sends the draft now; scheduled schedules it for the time the draft has, in its time zone.

### `cancel_campaign` (~90 tokens)

Stop a campaign

Stops a campaign, named by id, that is scheduled, sending or paused, and returns it stopped: nothing more goes out, and sends still waiting are cancelled. Messages already sent stay sent. A stopped campaign does not start again; its results stay readable. Stopping a draft, or a campaign that has finished, is refused in words.

Input parameters:

- `id` (string, required): The id in the resource path.

## Diagnostics

Captured diagnostic sections: TLS, DNSSEC, Authorisation, Transports. The full working is on the page: https://verifymcp.io/servers/app-cosend-mcp/mcp#diagnostics

## Score history

- 2026-11-21: 84
- 2026-11-20: 83
- 2026-11-19: 83
- 2026-11-18: 82
- 2026-11-17: 82
- 2026-11-16: 83
- 2026-11-15: 82
- 2026-11-14: 82
- 2026-11-13: 81
- 2026-11-12: 81
- 2026-11-11: 80
- 2026-11-10: 80
- 2026-11-09: 79
- 2026-11-08: 79
- 2026-11-07: 78
- 2026-11-06: 78
- 2026-11-05: 78
- 2026-11-04: 77
- 2026-11-03: 76
- 2026-11-02: 39
- 2026-11-01: 39

## Common questions

### What is the Cosend MCP server?

Cosend is an MCP server listed in the public MCP registry as app.cosend/mcp. WhatsApp Business inbox for AI apps: read and answer chats, run campaigns, deploy automations. This page covers its hosted endpoint (https://mcp.cosend.app/mcp).

### Is the Cosend MCP server safe to use?

Cosend scores 84 out of 100 on VerifyMCP. That is a record of what we were able to check automatically, not an endorsement. The category breakdown on this page shows every signal behind the number, including the ones we could not confirm.

### What tools does the Cosend MCP server expose?

Cosend exposes 125 tools: whoami, list_conversations, search_conversations, read_conversation, send_message, and 120 more. Their descriptions and schemas cost roughly 29,877 tokens of context every time the server is loaded.

### Does the Cosend MCP server require authentication?

Yes. Cosend asked us for credentials when we connected, so you will need to authorise it in your MCP client before it can do anything.

### Is the Cosend MCP server still maintained?

Cosend is still listed as active in the MCP registry. We last reached this channel on 21 November 2026. Those dates come from our own scans of the registry and the channel itself, not from anything the publisher announced.

### What did VerifyMCP test on the Cosend MCP server?

VerifyMCP ran 13 checks on Cosend, covering TLS certificate, Authorization, HTTPS, HSTS header and 9 more. Supply Chain Security and Provenance & Transparency do not apply to a hosted endpoint, so they were not tested. The score does not measure everything, and the scoring documentation lists what it leaves out.

## Links

- Remote endpoint: https://mcp.cosend.app/mcp
- Repository: https://github.com/cosendhq/cosend-plugin
- Website: https://cosend.app/mcp
- Changelog RSS feed: https://verifymcp.io/servers/app-cosend-mcp/mcp.xml
- Changelog JSON feed: https://verifymcp.io/servers/app-cosend-mcp/mcp/changelog.json
- Trust report (JSON): https://verifymcp.io/servers/app-cosend-mcp/mcp.json
- HTML version of this page: https://verifymcp.io/servers/app-cosend-mcp/mcp
