---
canonical_url: "https://docs.composio.dev/toolkits/outbound_dev"
markdown_url: "https://docs.composio.dev/toolkits/outbound_dev.md"
product: "platform"
version: null
last_updated: null
---

# Outbound

Outbound provides prospect search, enrichment, lists, campaign automation, inbox, billing, and sending-account administration. Use a least-privilege Products key for the product actions you need; Full access is required only for the organization wallet ledger. Read only cannot use mutations.

- **Category:** ai sales tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 119
- **Triggers:** 0
- **Slug:** `OUTBOUND_DEV`
- **Version:** 00000000_00

## Tools

### Add a list to a campaign

**Slug:** `OUTBOUND_DEV_ADD_LIST_TO_CAMPAIGN`

EXTERNAL SEND RISK: Add a people list to a campaign. In a running campaign, its people enter the active outreach sequence and may immediately queue or send their next due messages; review the campaign first. In a draft, enrollment waits for launch. Campaigns hold up to 10 lists; an existing list is reported as alreadyPresent. Free, limited to 500/day.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | One of your people lists. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add People to List

**Slug:** `OUTBOUND_DEV_ADD_PEOPLE_TO_LIST`

Add people who already exist in the Outbound workspace to an existing people list using their IDs. People already in the list are skipped, so repeating the same request does not add duplicates. This action is free and does not create contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the existing people list to update. |
| `person_ids` | array | Yes | IDs of 1-5000 people who already exist in this Outbound workspace, obtained from another list row's id or an upload's personIds. People already in the target list are skipped. This action does not create contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add rows to a list

**Slug:** `OUTBOUND_DEV_ADD_ROWS_TO_LIST`

Adds up to 500 people to a people list from what you know about them, each with at least one of `email`, `linkedinUrl`, `firstName` and `lastName`. Nothing is looked up: an email address is kept as sent, unchecked. Each row becomes a new person, even one already in the workspace: a row sent twice is added twice, and so is every row of a call sent again. A company list answers `422` `people_list_required`. Free. **Scope:** lists, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rows` | array | Yes | The people to add, at most 500. Each row becomes a new person, even one already in the workspace. |
| `list_id` | string | Yes | The list's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve queued messages

**Slug:** `OUTBOUND_DEV_APPROVE_QUEUED_SENDS`

EXTERNAL SEND EFFECT: approves queued messages for delivery; approved messages may be sent to campaign recipients. Approves up to 100 messages waiting for approval: they become `scheduled` and go out at their time. Ids the organization does not have come back in `notFound`, and messages not waiting for approval in `ignored`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `send_ids` | array | Yes | 1 to 100 queued messages, each once, by the `id` the queue lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Suggest company filter values

**Slug:** `OUTBOUND_DEV_AUTOCOMPLETE_COMPANY_FILTER`

Suggests company names (`company`), headquarters places (`location`, values of `headquartersCity`) or states (`state`, values of `headquartersStateName`) as they are typed. `orgType=investor` narrows company names to investors, for the `investors` filter. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | What has been typed so far, two characters or more. |
| `field` | string ("company" | "location" | "state") | Yes | The filter to suggest values for: company names, headquarters places, or states. |
| `org_type` | string | No | `investor` narrows `field=company` to investors. Only with `field=company`. |
| `countries` | string | No | Only with `field=state`: comma-separated countries whose states to suggest, as `USA` or `US`. Without it, every country's. |
| `excluded_countries` | string | No | Only with `field=state`: comma-separated countries whose states to leave out. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Suggest people filter values

**Slug:** `OUTBOUND_DEV_AUTOCOMPLETE_PEOPLE_FILTER`

Suggests values for a free-text people filter as it is typed: job titles, companies, websites, locations, regions, schools and skills. Send a suggestion's `name` as the filter's value. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | What has been typed so far. |
| `field` | string ("title" | "company" | "website" | "location" | "region" | "school" | "skill") | Yes | The filter to suggest values for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel a job

**Slug:** `OUTBOUND_DEV_CANCEL_JOB`

CANCELLATION HAS IRREVERSIBLE EFFECTS: This stops a running enrichment job. Work already completed is kept and charged; unprocessed work will not resume, and the unused hold is released. Stops a running people enrichment or list enrichment. The job winds down, then reads `cancelled`; what it found before it stopped is kept and charged, and the rest of what was held is released. Asking again changes nothing. A job that already ended answers `409` `job_already_ended`, and one still starting `409` `job_starting`: try again in a few seconds. Another organization's job answers `404`. Free, with its own limit. **Scope:** a key that can write the job's product (enrichment, for an enrichment job).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The job's id, as the call that started it answered. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check a campaign is ready to launch

**Slug:** `OUTBOUND_DEV_CHECK_CAMPAIGN_READINESS`

Runs the launch checks without launching: whether `POST /v1/campaigns/{campaignId}/launch` would start the campaign now and, if not, `reason`, the code launching would answer with. `people` counts the people on the campaign's lists: those with a work email, those without one (an email-only campaign skips them) and those with a LinkedIn profile. Nothing changes. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Connect Mailbox

**Slug:** `OUTBOUND_DEV_CONNECT_MAILBOX`

PAID RECURRING CONNECTION: Connect or sign in again to an SMTP/IMAP mailbox; both sign-ins are checked and replies sync over IMAP. The check can take up to two minutes. Connecting an existing mailbox keeps its settings. Cost is exactly $1 per mailbox for each 30 days it remains connected: the first fee is charged when it connects and every 30 days thereafter. The balance must cover the first period when called. If another call spends that balance first, the mailbox is disconnected at the next fee run, usually within 15 minutes. Unpaid renewal is retried daily and disconnects after 3 days. The call itself is free. Use an idempotency_key because retries without one can repeat connection work; never log or expose the supplied mailbox password. Disconnect separately to stop fees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Sender name for a newly connected mailbox. |
| `password` | string | Yes | Mailbox password or provider app password. Treat it as a secret: never log, display, or expose it. Outbound checks it by signing in, stores it encrypted, and never returns it. |
| `auth_user` | string | No | Mailbox sign-in name when it differs from email_address. |
| `imap_host` | string | Yes | Incoming IMAP server host, such as imap.example.com. |
| `imap_port` | number | No | IMAP port; the default is 993. |
| `smtp_host` | string | Yes | Outgoing SMTP server host, such as smtp.example.com. |
| `smtp_port` | number | No | SMTP port: 465 for TLS (the default), or 587 for STARTTLS. |
| `imap_secure` | boolean | No | Whether IMAP uses TLS; the default is true. |
| `smtp_secure` | boolean | No | True for TLS on port 465; false for STARTTLS on port 587. |
| `email_address` | string | Yes | Mailbox address; Outbound stores it in lower case as the account ID. |
| `idempotency_key` | string | No | Visible-ASCII operation key. Use a fresh key for a new connection and reuse it only for an identical retry after timeout, 5xx, or 429. Successes replay for 24 hours. Password changes are not compared for replay; 4xx frees the key, and uncertain 5xx outcomes can return idempotency_in_progress or idempotency_outcome_unknown rather than connecting twice. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Connect Mailboxes in Bulk

**Slug:** `OUTBOUND_DEV_CONNECT_MAILBOXES_BULK`

PAID RECURRING ASYNC IMPORT: Start connecting 1-250 SMTP/IMAP mailboxes and return only the immediate 202 snapshot; poll GET_MAILBOX_IMPORT_STATUS, then list email accounts to determine which sign-ins succeeded. Only one import runs at a time. Each connected mailbox costs exactly $1 for each 30 days it remains connected, charged on connection and every 30 days. Balance must cover every first period; a race that consumes funds disconnects affected accounts at the next fee run, usually within 15 minutes. Renewal is retried daily and disconnects after 3 unpaid days. The call itself is free. Use an idempotency_key; retries under a new key may start another import. Never log or expose mailbox passwords.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mailboxes` | array | Yes | One to 250 SMTP/IMAP mailboxes to connect in the background. |
| `idempotency_key` | string | No | Visible-ASCII operation key. Use a fresh key for a new import and reuse it only for an identical retry after timeout, 5xx, or 429. Successful 202 responses replay for 24 hours; mailbox passwords are not compared. A 4xx frees the key, while uncertain 5xx outcomes can remain held and must not be retried under a new key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy an A/B variant

**Slug:** `OUTBOUND_DEV_COPY_CAMPAIGN_STEP_VARIANT`

Replaces the steps of one variant of an A/B split with copies of the other's, so you can change one thing and compare. `stepId` is the split. A step that is not a split answers `422` `step_not_a_split`. It has its own limit too, 20 a minute and 300 a day. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | string | Yes | The step's id, from `GET /v1/campaigns/{campaignId}/steps`. |
| `campaign_id` | string | Yes | The campaign's id. |
| `to_branch_key` | string ("a" | "b") | Yes | The other variant, whose steps the copies replace. |
| `from_branch_key` | string ("a" | "b") | Yes | The variant to copy: `a` or `b`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count companies

**Slug:** `OUTBOUND_DEV_COUNT_COMPANIES`

Counts the companies a search would find, without listing them. Send exactly one of `query`, `filters`, `savedSearchId` or `savedSearchName`, as the search takes them. A new count runs in the background: the first answer is `202` with `status` `pending`. Send the same request again every few seconds until it answers `200` with `status` `ready` and the `total`. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Which companies to find, in plain language. It is turned into filters, which the page answers with as `filters`. |
| `filters` | object | No | Filters by name, with values from `GET /v1/companies/filters` and `GET /v1/companies/autocomplete`. |
| `saved_search_id` | string | No | Run a saved company search by its id. |
| `saved_search_name` | string | No | Run a saved company search by its title. A title several saved searches share answers 409 `saved_search_name_ambiguous`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Email Conversations

**Slug:** `OUTBOUND_DEV_COUNT_CONVERSATIONS`

Count email conversations by folder, optionally limited to selected mailboxes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folders` | string | No | Comma-separated email folders to count: inbox, sent, unread, favorite, archived, spam, or trash. Omit to count all folders. |
| `mailbox` | string | No | One mailbox or up to 20 comma-separated mailboxes to count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count people

**Slug:** `OUTBOUND_DEV_COUNT_PEOPLE`

Counts the people a search would find, without listing them. Send exactly one of `query`, `filters`, `savedSearchId` or `savedSearchName`, as the search takes them. A new count runs in the background: the first answer is `202` with `status` `pending`. Send the same request again every few seconds until it answers `200` with `status` `ready` and the `total`. A count takes up to about a minute and a half. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Who to find, in plain language. It is turned into filters, which the page answers with as `filters`. |
| `filters` | object | No | Filters by name, with values from `GET /v1/people/filters` and `GET /v1/people/autocomplete`. |
| `saved_search_id` | string | No | Run a saved people search by its id. |
| `saved_search_name` | string | No | Run a saved people search by its title. A title several saved searches share answers 409 `saved_search_name_ambiguous`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Draft Campaign

**Slug:** `OUTBOUND_DEV_CREATE_CAMPAIGN`

Create a manual or AI-generated draft campaign for one or more people lists, optionally from a template. AI-generated draft steps are written from the prompt in the background. This action only creates a draft: it cannot launch the campaign or send any message. Launching requires the separate launch operation. This action cannot launch the campaign or send messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Campaign name, 1-200 characters. |
| `prompt` | string | No | For an `ai-generated` campaign, what you offer and to whom, up to 5,000 characters. Draft steps are written from it in the background. |
| `channels` | array | No | Channels for which steps are created, in order. Omit for email, and do not send with `template_id`, whose template decides the channels. This action does not send messages. |
| `cta_link` | string | No | The HTTP or HTTPS link draft steps insert for `{CTA Link}`, up to 2,000 characters. Send an empty string for no link. |
| `list_ids` | array | Yes | One to ten people-list IDs. Their people are enrolled only if this draft is later launched through a separate operation. |
| `timezone` | string | No | IANA time zone for a future sending schedule, such as Europe/Lisbon. |
| `email_days` | array | No | Allowed future sending days using full English weekday names. Omit to use Monday through Friday. |
| `is_dynamic` | boolean | No | Whether people added to the campaign's lists after a future launch are enrolled as they arrive. |
| `start_date` | string | No | ISO 8601 date-time before which a later-launched campaign may not send. |
| `template_id` | string | No | A campaign template whose steps are copied into the draft. Its steps decide the channels, so omit `channels`. |
| `campaign_type` | string ("manual" | "ai-generated") | No | `manual` creates empty steps to write yourself. `ai-generated` writes draft steps from `prompt` in the background. Neither type is launched or sends messages by this action. |
| `exclude_list_ids` | array | No | Up to ten people lists whose contacts must never be enrolled. |
| `knowledge_hub_id` | string | No | For an `ai-generated` campaign, the knowledge hub its draft steps draw on. Omit to use the default hub. |
| `writing_style_id` | string | No | For an `ai-generated` campaign, the writing style its draft steps follow. Omit to use the default style. |
| `daily_email_limit` | integer | No | Maximum future emails per day (1-10000). Omit for no campaign-level limit. |
| `exclude_contacted` | string ("none" | "ever" | "last_1_month" | "last_3_months" | "last_6_months" | "last_1_year") | No | Exclude contacts reached by prior campaigns during this period. |
| `add_unsubscribe_link` | boolean | No | Whether future campaign emails include a one-click unsubscribe link. |
| `exclude_company_lists` | array | No | Up to 20 company or people lists. People working at one of their companies are not enrolled when this draft is later launched. |
| `exclude_engaged_contacts` | boolean | No | Whether to skip people who replied to one of your campaigns. |
| `click_tracking_enabled_at` | string | No | ISO 8601 date-time from which click tracking is enabled. Omit to leave click tracking off. A step that waits for a click needs it enabled. |
| `daily_linkedin_message_limit` | integer | No | Maximum future LinkedIn messages and InMails per day, from 1 to 10,000. |
| `open_rate_tracking_enabled_at` | string | No | ISO 8601 date-time from which open tracking is enabled. Omit to leave open tracking off. |
| `daily_linkedin_connection_limit` | integer | No | Maximum future LinkedIn invitations per day, from 1 to 10,000. |
| `send_only_to_validated_emails_enabled_at` | string | No | ISO 8601 date-time from which only people with a validated email are enrolled. Omit to also allow catch-all and unchecked addresses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Exclude a list from campaigns

**Slug:** `OUTBOUND_DEV_CREATE_CAMPAIGN_EXCLUSION`

Excludes one of your people or company lists from every campaign of your organization: from their next enrollment on, campaigns enrolling people from their lists skip the list's people or, for a company list, everyone whose record is linked to one of its companies. People or companies added to the list later are skipped too, and deleting the list does not delete its exclusion: its people stay skipped. It does not stop people a campaign already enrolled, and it does not cover people added with `POST /v1/campaigns/{campaignId}/people`. A list the organization does not have answers `404` `list_not_found`; a list kept automatically, such as the list of people who unsubscribed, `422` `list_not_excludable`; a list it already excludes, `409` `list_already_excluded`. Exclusion calls have a limit of their own, 30 a minute and 2,000 a day. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | The people list or company list to exclude: one your organization made. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a step to a campaign

**Slug:** `OUTBOUND_DEV_CREATE_CAMPAIGN_STEP`

Adds a step: a message on one channel, a LinkedIn visit or like, or a condition that branches the sequence. Place it with `sequenceNumber`, in the main sequence or, with `parentStepId` and `branchKey`, in a condition's lane. Once leads move through a branched sequence its shape is fixed: `409` `sequence_structure_locked`. An `ai_generated` step has its topic and title written before the answer. It answers once the writing is done, which can take a minute: allow two minutes. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | Up to 10 addresses copied on every email of the step. |
| `body` | string | No | A `manual` step's message, up to 20,000 characters; the tokens `GET /v1/campaigns/{campaignId}/variables` lists, such as `{Contact First Name}`, are filled in for each lead. On a `linkedin_connection` step, the invitation note, up to 200 characters. Not on visits, likes and conditions. |
| `type` | string ("manual" | "ai_generated" | "ai_reply") | No | `manual` (the default) sends `subject` and `body` as written; `ai_generated` writes each message for each lead from a topic it writes itself; `ai_reply` drafts a reply from `topic` that waits for your approval. A condition is always `manual`. |
| `topic` | string | No | What the step should say, up to 500 characters. Needed by `ai_reply`; `ai_generated` writes its own. |
| `channel` | string ("email" | "linkedin_connection" | "linkedin_message" | "linkedin_visit" | "linkedin_like" | "inmail" | "condition") | Yes | `email`, `linkedin_connection` (an invitation), `linkedin_message` (to a connection), `linkedin_visit` (a profile visit), `linkedin_like` (a like on a recent post), `inmail`, or `condition`: a branch that waits for `conditionType` and sends each lead down its `yes` or `no` lane, or for an `ab_split`, down variant `a` or `b` at once. A `linkedin_connection` step cannot follow a `linkedin_message` step. |
| `subject` | string | No | A `manual` step's subject line, up to 500 characters. Not on visits, likes and conditions. |
| `branch_key` | string ("yes" | "no" | "a" | "b") | No | The lane of `parentStepId`: `yes` or `no` under a condition, `a` or `b` under an A/B split. |
| `split_arms` | array | No | `ab_split` only: both variants, `a` then `b`, each `{ key, label?, weight }`. 50 each when left out. |
| `campaign_id` | string | Yes | The campaign's id. |
| `days_between` | integer | Yes | Days to wait after the step before (or after the start, for the first step), 0 to 90. On a condition, how long it waits for its signal, 1 to 30 days; an `ab_split` waits for nothing: send 0. |
| `condition_type` | string ("invite_accepted" | "clicked_link" | "ab_split") | No | Conditions only: `invite_accepted` waits for the invitation of the nearest `linkedin_connection` step before it, `clicked_link` for a click in the nearest email before it, and `ab_split` splits leads between variants `a` and `b` by `splitArms`. Conditions can be added only before the campaign starts. |
| `parent_step_id` | string | No | The condition whose lane the step goes in, with `branchKey`. Left out, the step goes in the main sequence. |
| `sequence_number` | integer | Yes | The step's place, from 0, in the main sequence or in the lane `parentStepId` and `branchKey` name. Send the length of the sequence or lane to add at its end; a taken place answers `409` `step_position_taken`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save a campaign as a template

**Slug:** `OUTBOUND_DEV_CREATE_CAMPAIGN_TEMPLATE`

Keeps a campaign's steps and schedule as a template. Start a campaign from it with `templateId` on `POST /v1/campaigns`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The template's name. |
| `campaign_id` | string | Yes | The campaign whose steps and schedule (sending days, hours, time zone and lists) the template keeps. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a folder

**Slug:** `OUTBOUND_DEV_CREATE_FOLDER`

Creates a folder for people lists (the default) or for company lists. No two folders for one kind of list share a name: a name in use answers `409` `folder_name_taken`. Move a list into it with `PATCH /v1/lists/{listId}`. Free. **Scope:** lists, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The folder's name. No two folders for one kind of list share a name. |
| `type` | string ("people" | "company") | No | The kind of list the folder holds: people (the default) or company. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a knowledge hub

**Slug:** `OUTBOUND_DEV_CREATE_KNOWLEDGE_HUB`

Builds a knowledge hub from up to 20 websites and 50 notes, in the background: it answers `202` with the hub `processing`. Read it with `GET /v1/knowledge-hubs/{hubId}` until its `status` is `complete`, or `draft` if building failed, then read its pages. The organization has one hub, its default: a second answers `409` `knowledge_hub_already_exists`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The hub's name. Left out, one is taken from what is read. |
| `notes` | array | No | Up to 50 notes the pages are also written from. |
| `websites` | array | Yes | 1 to 20 sites, read in the background into one set of pages. A site that cannot be read is no error: its `lastCrawledAt` stays absent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a page to a hub

**Slug:** `OUTBOUND_DEV_CREATE_KNOWLEDGE_HUB_PAGE`

Adds a page you wrote to a hub. Campaigns can draw on it once it is answered. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | The page's title. |
| `hub_id` | string | Yes | The knowledge hub's id. |
| `content` | string | Yes | The page in Markdown, up to 60,000 characters. |
| `category` | string ("overview" | "products" | "pricing" | "icp-use-cases" | "differentiators" | "competitors" | "faq" | "source-digest" | "custom") | No | What the page is about. `custom` when left out. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create LinkedIn Connect Link

**Slug:** `OUTBOUND_DEV_CREATE_LINKEDIN_CONNECT_LINK`

PAID RECURRING CONNECTION LINK: Create a sensitive hosted LinkedIn sign-in URL valid for 24 hours. Send it only to the intended seat owner; whoever opens it can connect a seat to the organization. The caller never handles the owner's password or session. After use, poll LIST_SENDING_ACCOUNTS with channel=linkedin until the seat is connected. Each connected seat costs exactly $10 for every 30 days it remains connected, charged on connection and every 30 days. Balance must cover the first period when this link is requested. If another call spends those funds first, the seat disconnects at the next fee run, usually within 15 minutes. Renewal is retried daily and disconnects after 3 unpaid days. Creating the link itself is free. No idempotency key is supported, so a retry can create another valid link.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create LinkedIn Reconnect Link

**Slug:** `OUTBOUND_DEV_CREATE_LINKEDIN_RECONNECT_LINK`

Create a sensitive hosted LinkedIn sign-in URL, valid for 24 hours, to reconnect a seat after LinkedIn ended its session. Share it only with the seat owner; whoever opens it can sign the organization seat in again. The caller never handles the owner's password or session. Poll GET_SENDING_ACCOUNT until isConnected is true. Reconnection costs nothing while the seat's existing 30 paid days remain. A seat that was signed out when its fee fell due stopped billing; reconnecting it starts a new 30-day period costing exactly $10. No idempotency key is supported, so a retry can create another valid link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | LinkedIn seat ID from the account list whose ended session should reconnect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List

**Slug:** `OUTBOUND_DEV_CREATE_LIST`

Create an empty people or company list for organizing prospects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique list name, 1-255 characters. |
| `list_type` | string ("people" | "company") | No | Kind of records the list will hold; it cannot be changed later. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a saved search

**Slug:** `OUTBOUND_DEV_CREATE_SAVED_SEARCH`

Keeps a search's `filters` under a `title`, for people (the default) or for companies. To keep a search you ran, send the `filters` its page answered with. Run a saved people search with `POST /v1/saved-searches/{savedSearchId}/run`, or any saved search as `savedSearchId` in a search or a count. Free. **Scope:** search, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("people" | "company") | No | The kind of search the filters are for. It cannot change later. |
| `title` | string | Yes | The saved search's title. Titles need not be unique, but a shared title cannot be run by name. |
| `filters` | object | Yes | The search's filters, as the people or company search takes them, such as the `filters` a search page answered with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a tracking domain

**Slug:** `OUTBOUND_DEV_CREATE_TRACKING_DOMAIN`

Adds `hostname` as your organization's tracking domain and answers it with its `dnsTarget`, `pending_dns` when it is new. Then add one CNAME record at your DNS provider: its name is the hostname and its value is `dnsTarget`. The domain is checked every 5 minutes for about a day, or at once with `POST /v1/tracking-domains/{trackingDomainId}/verify`; once the record is found, the hostname is set up and its certificate issued, and it becomes `active`, usually within half an hour. Follow its `status` with `GET /v1/tracking-domains`. Once it is active, every campaign with click tracking on (`clickTrackingEnabledAt`) sends its tracked links through it: a link in its emails goes to your hostname, where a short redirect page sends the person on to the address you wrote. A campaign with click tracking off sends links as written. The open tracking image, the unsubscribe link, test emails and messages sent outside a campaign never use it. The hostname must be a subdomain of at least three la...

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hostname` | string | Yes | A subdomain of a domain you own, such as `go.fernway.co`, without `https://` or a path: the hostname the tracked links of your campaign emails will go through. It needs at least three labels, so `fernway.co` is refused. It is lower-cased. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Decline queued messages

**Slug:** `OUTBOUND_DEV_DECLINE_QUEUED_SENDS`

IRREVERSIBLE QUEUE EFFECT: permanently declines the selected queued messages so they will not be sent. Declines up to 100 messages waiting for approval or scheduled: they become `stopped`, and their people's sequences in the campaign end. Ids the organization does not have come back in `notFound`, and messages that already went out in `ignored`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `send_ids` | array | Yes | 1 to 100 queued messages, each once, by the `id` the queue lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Campaign

**Slug:** `OUTBOUND_DEV_DELETE_CAMPAIGN`

Delete a campaign so it cannot send further messages while retaining its people and lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the campaign to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an exclusion

**Slug:** `OUTBOUND_DEV_DELETE_CAMPAIGN_EXCLUSION`

Stops excluding a list: campaigns no longer skip its people from their next enrollment on. The list is kept. The people the exclusion kept out are not enrolled by this call, but the next enrollment takes them: a running campaign with `isDynamic` enrolls them from its lists within 30 minutes, and any campaign when their list is added to it or it is launched. An exclusion the organization does not have answers `404` `exclusion_not_found`. Exclusion calls have a limit of their own, 30 a minute and 2,000 a day. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `exclusion_id` | string | Yes | The exclusion's id, not its list's. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a step

**Slug:** `OUTBOUND_DEV_DELETE_CAMPAIGN_STEP`

Deletes a step from a campaign. A step the campaign does not have answers `404` `step_not_found`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | string | Yes | The step's id, from `GET /v1/campaigns/{campaignId}/steps`. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a campaign template

**Slug:** `OUTBOUND_DEV_DELETE_CAMPAIGN_TEMPLATE`

Deletes a template. Campaigns made from it keep their steps. Another organization's template answers `404` `template_not_found`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | The template's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a folder

**Slug:** `OUTBOUND_DEV_DELETE_FOLDER`

IRREVERSIBLE: Deletes the folder permanently. Lists are retained but moved out of all folders. Deletes a folder. Its lists are kept, out of every folder. Free. **Scope:** lists, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | The folder's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a knowledge hub

**Slug:** `OUTBOUND_DEV_DELETE_KNOWLEDGE_HUB`

Deletes a hub and its pages. The default hub cannot be deleted (`409` `knowledge_hub_default_undeletable`): make another the default first. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hub_id` | string | Yes | The knowledge hub's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a hub's page

**Slug:** `OUTBOUND_DEV_DELETE_KNOWLEDGE_HUB_PAGE`

Deletes a page from a hub. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hub_id` | string | Yes | The knowledge hub's id. |
| `page_id` | string | Yes | The page's id, from `GET /v1/knowledge-hubs/{hubId}/pages`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List

**Slug:** `OUTBOUND_DEV_DELETE_LIST`

Delete a list and its custom columns while retaining its people in the workspace and in other lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a saved search

**Slug:** `OUTBOUND_DEV_DELETE_SAVED_SEARCH`

IRREVERSIBLE: Deletes the saved search permanently. This does not delete prior search results. Deletes a saved search. Free. **Scope:** search, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `saved_search_id` | string | Yes | The saved search's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a tracking domain

**Slug:** `OUTBOUND_DEV_DELETE_TRACKING_DOMAIN`

Deletes your tracking domain: campaign emails send their tracked links through the shared link address again. Links in emails already sent keep working only while the hostname's CNAME record stays in place, so keep the record. A domain that was ever `active` stays held by your organization, so no other organization can take its hostname, and adding the same hostname again brings it back; one that never became active is deleted outright and its hostname is free. Deleting it again answers `404` `tracking_domain_not_found`. While the domain is still being switched off, it answers `409` `tracking_domain_removal_pending`: it is not deleted yet, so send the delete again in a minute or two. Tracking domain calls have a limit of their own, 30 a minute and 1,000 a day. Adding, checking and deleting one also share a tighter one, 10 a minute and 200 a day. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tracking_domain_id` | string | Yes | The tracking domain's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Sending Account

**Slug:** `OUTBOUND_DEV_DISCONNECT_SENDING_ACCOUNT`

IRREVERSIBLE DISCONNECT EFFECT: Disconnect a mailbox together with its synced emails and warmup, or disconnect a LinkedIn seat; campaigns immediately stop sending from it. The recurring 30-day fee stops, but already-paid days are not refunded; reconnecting before those days expire costs nothing more. Disconnecting an already disconnected account fails, and this operation has no idempotency key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("email" | "linkedin") | Yes | Account channel: email for a mailbox or linkedin for a LinkedIn seat. |
| `account_id` | string | Yes | Mailbox address or LinkedIn seat ID to disconnect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate a campaign

**Slug:** `OUTBOUND_DEV_DUPLICATE_CAMPAIGN`

Copies a campaign, with its settings and steps, into a new draft named `Copy of` and the original's name. Nobody is enrolled in the copy until you launch it. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich a list's people

**Slug:** `OUTBOUND_DEV_ENRICH_LIST`

PAID ASYNC JOB: Enrich missing work email, phone, or both on a people list. Process up to max_rows (10,000) from offset; use successive offsets for larger lists. Poll OUTBOUND_DEV_GET_JOB, then read saved list rows. An active job can be stopped with OUTBOUND_DEV_CANCEL_JOB. empty list completes free. max_spend_usd rejects the job before any hold if its maximum cost is too high. Package/waterfall prices per new email are $0.01/$0.05 and per new phone $0.05/$0.10; existing values are free and unused held funds are released. Starts are limited to 10/minute and 200/day.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `find` | string ("email" | "phone" | "email_and_phone") | No | What to find: a work `email` (the default), a `phone` number, or both (`email_and_phone`). |
| `offset` | integer | No | How many of the list's rows, in its order, to skip before the run starts: 0 when left out. Enrich a long list in runs, each with `offset` where the last one ended. |
| `list_id` | string | Yes | The people list whose rows to enrich. |
| `max_rows` | integer | No | The most rows to enrich, from 1 to 10,000. Left out, the job runs over every row up to that many. |
| `providers` | string ("package" | "waterfall") | No | Where to look: `package` (the default) searches our own data package; `waterfall` searches the package, then a fixed series of further providers. A value's price depends on who found it. |
| `max_spend_usd` | number | No | The most the job may cost, in US dollars. A job that could cost more is refused before anything is held or started. |
| `idempotency_key` | string | No | Names this operation, so a retry with the same key and body gets the first success again, marked `Idempotent-Replayed`, instead of running or charging twice. A mailbox's `password` is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (`4xx`) frees the key at once, so a corrected retry runs. After a server error (`5xx`), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers `409` `idempotency_in_progress`; after that, a send or import that may already have gone out answers `409` `idempotency_outcome_unknown` instead of running again. 1 to 255 visible ASCII characters, such as a UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich People in Batch

**Slug:** `OUTBOUND_DEV_ENRICH_PEOPLE_BATCH`

PAID, ASYNCHRONOUS, AND RETAINED CONTACTS: Start one job to enrich 1-100 people and attempt to save or update each person and discovered value in the Outbound workspace. Per-person errors are returned without saving that person; successful contacts can remain because Outbound has no person-delete endpoint. Each newly found email costs $0.01 by package or $0.05 by waterfall, and each newly found phone costs $0.05 or $0.10 respectively; existing values and per-person errors are free. The maximum hold is people count multiplied by $0.01/$0.05/$0.06 for email/phone/both with package, or $0.05/$0.10/$0.15 with waterfall (at most $15 for 100 people). Set max_spend_usd to impose a lower hard cap. This action returns only the 202 job snapshot, not enrichment results; call OUTBOUND_DEV_GET_JOB with the returned job ID until terminal to obtain ordered per-person outcomes, polling no faster than every 15 seconds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `find` | string ("email" | "phone" | "email_and_phone") | No | Value to find for every person. Per-person maximum hold with package is $0.01 for email, $0.05 for phone, or $0.06 for both; with waterfall it is $0.05, $0.10, or $0.15 respectively. |
| `people` | array | Yes | One to 100 people, each identified exactly one way. Outbound attempts to save or update each person as a retained workspace contact; a person with an error is not saved. Outbound has no person-delete endpoint. |
| `providers` | string ("package" | "waterfall") | No | package charges $0.01 per newly found email and $0.05 per newly found phone; waterfall can charge $0.05 and $0.10 respectively. Existing values and per-person errors are free. |
| `max_spend_usd` | number | No | Hard cap in USD for this job. Outbound refuses the request before holding funds or starting work when people count multiplied by the per-person maximum for find/providers exceeds this value. |
| `idempotency_key` | string | No | Visible-ASCII operation key. Use a fresh value for a new batch and reuse it only for the identical body after a timeout, 5xx, or 429. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich Person

**Slug:** `OUTBOUND_DEV_ENRICH_PERSON`

PAID AND RETAINED CONTACT: Find a person's work email, phone, or both and save the person and discovered contact data in the Outbound workspace. Package lookup costs up to $0.01 for email, $0.05 for phone, or $0.06 for both; waterfall costs up to $0.05, $0.10, or $0.15 respectively. The maximum is held before lookup, existing values and no-result calls are free, and only new values in `found` are charged. Outbound provides no person-delete endpoint, so the saved contact can remain after this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `find` | string ("email" | "phone" | "email_and_phone") | No | Contact data to find. Package pricing is up to $0.01 for email, $0.05 for phone, or $0.06 for both; waterfall pricing is up to $0.05, $0.10, or $0.15 respectively. The maximum is held before the request. |
| `full_name` | string | No | Person's full name. Use instead of first_name and last_name, and supply at least one of company_name or company_domain. |
| `last_name` | string | No | Person's last name when identifying by split name. Supply first_name, last_name, or both, plus at least one of company_name or company_domain. |
| `person_id` | string | No | Existing workspace person ID. Use this identity alone; it must be the 24-character hexadecimal ID from a list row, upload, or earlier enrichment. |
| `providers` | string ("package" | "waterfall") | No | Where to search. package uses the lowest bounded price; waterfall checks additional providers and can take over a minute at higher prices. |
| `first_name` | string | No | Person's first name when identifying by split name. Supply first_name, last_name, or both, plus at least one of company_name or company_domain. |
| `company_name` | string | No | Employer name for name-based identification. Supply company_name, company_domain, or both. |
| `linkedin_url` | string | No | LinkedIn profile URL. Use this identity alone. |
| `company_domain` | string | No | Employer website domain for name-based identification, without a URL path. Supply company_domain, company_name, or both. |
| `idempotency_key` | string | No | Visible-ASCII operation key. Use a fresh value for a new enrichment and reuse it only when retrying the identical body after a timeout, 5xx, or 429. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add people to a campaign

**Slug:** `OUTBOUND_DEV_ENROLL_PEOPLE_IN_CAMPAIGN`

EXTERNAL SEND RISK: Enroll 1-60 people in a running campaign and start each active outreach sequence, which may immediately queue or send the next due message; review the campaign first. Outcomes report added, already enrolled, missing contact data, not found, or failed. Repeats do not duplicate enrollment. No contact lookup occurs. Draft or paused campaigns reject the call. Free, limited to 10/minute and 500/day.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_ids` | array | Yes | 1 to 60 people, each once: the `id` of their rows in a list, or the ids an upload or enrichment answered with. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the calling key

**Slug:** `OUTBOUND_DEV_GET_CALLING_KEY`

Which key is calling and for which organization: the key's scope, and what it spent today against its daily cap. Free, for any key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a campaign

**Slug:** `OUTBOUND_DEV_GET_CAMPAIGN`

One campaign: its type and status, how writing an `ai-generated` campaign stands (`initializationStatus`), its lists, and its settings under the names `POST /v1/campaigns` takes them: its start, sending days and time zone, who it leaves out, open and click tracking, the unsubscribe link, daily limits and link. A setting without a value is absent. Another organization's campaign, or a deleted one, answers `404` `campaign_not_found`. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a campaign's A/B results

**Slug:** `OUTBOUND_DEV_GET_CAMPAIGN_AB_RESULTS`

For each A/B split step: its variants and their weights, and how each variant did, in all and since the weights last changed: leads, invitations sent and accepted, replies, positive replies, meetings, bounces and unsubscribes, with their rates, and replies by day in `timezone`. `since` and `to` count only the leads that reached a split between them. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Count only the leads that reached a split at or before this ISO 8601 date-time, not before `since`. |
| `since` | string | No | Count only the leads that reached a split at or after this ISO 8601 date-time. |
| `timezone` | string | No | The IANA time zone whose days `replySeries` counts by, such as `Europe/Lisbon`. UTC by default. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a campaign's stats

**Slug:** `OUTBOUND_DEV_GET_CAMPAIGN_STATS`

Messages sent, the people who opened and clicked, and replies, since `since` (12 months ago when left out). Opens and clicks are counted only while tracking is on. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | string | No | Count from this ISO 8601 date-time. 12 months ago when left out. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Conversation

**Slug:** `OUTBOUND_DEV_GET_CONVERSATION`

Get one email thread or LinkedIn chat with every message, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("email" | "linkedin") | Yes | Conversation channel: email or linkedin. |
| `conversation_id` | string | Yes | Conversation ID returned by list conversations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job

**Slug:** `OUTBOUND_DEV_GET_JOB`

FREE: Get an asynchronous job's progress, final charge, and ordered per-person enrichment outcomes. While status is running, poll this action no faster than every 15 seconds. Any key in the organization that started the job can read its status; ordered people-enrichment results are omitted unless the key can read enrichment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Job ID returned by the action that started the asynchronous job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a knowledge hub

**Slug:** `OUTBOUND_DEV_GET_KNOWLEDGE_HUB`

One knowledge hub: its status, its websites, with when each was last read, and its notes. Another organization's hub answers `404` `knowledge_hub_not_found`. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hub_id` | string | Yes | The knowledge hub's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List

**Slug:** `OUTBOUND_DEV_GET_LIST`

Get one list's status, contact-data metrics, row count, and custom columns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mailbox Import Status

**Slug:** `OUTBOUND_DEV_GET_MAILBOX_IMPORT_STATUS`

Return whether the organization currently has a mailbox import running and when it started. This is organization-wide rather than tied to one import. Free and read-only; after completion, list email accounts to see successful connections.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a request

**Slug:** `OUTBOUND_DEV_GET_REQUEST`

One request of the last 30 days: its status, time and cost, the address it came from and, for a charged call, the balance after its charge. Request and response bodies are never kept. A key without full access reads only its own requests; another key's request answers 404. Free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | The request's id, as its X-Request-Id header and the requests list give it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a saved search

**Slug:** `OUTBOUND_DEV_GET_SAVED_SEARCH`

One saved search. Another organization's, or one that was deleted, answers `404`. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `saved_search_id` | string | Yes | The saved search's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sending Account

**Slug:** `OUTBOUND_DEV_GET_SENDING_ACCOUNT`

Get one mailbox or LinkedIn seat, including its signature and connection state. LinkedIn seats also include status and daily and weekly sending limits. Free and read-only; a missing organization account returns account_not_found.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("email" | "linkedin") | Yes | Account channel: email for a mailbox or linkedin for a LinkedIn seat. |
| `account_id` | string | Yes | Account ID from the account list: mailbox address or LinkedIn seat ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get usage

**Slug:** `OUTBOUND_DEV_GET_USAGE`

Calls, billed units, misses, errors and spend for each UTC day of the range, by product, and for each route. A key with full access reads the whole organization's usage, or one key's with `apiKeyId`; any other key reads only its own. Free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | The last UTC day, as `YYYY-MM-DD`. A range covers at most 90 days. |
| `from_` | string | No | The first UTC day, as `YYYY-MM-DD`. Without `from` and `to`, the last 30 days, today included. |
| `api_key_id` | string | No | Only this key's usage. A key without full access reads only its own. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the balance

**Slug:** `OUTBOUND_DEV_GET_WALLET`

The organization's balance, what is set aside for calls in progress, what new calls can use, and whether auto-recharge is on, with the calling key's spend today. Free, for any key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Launch a campaign

**Slug:** `OUTBOUND_DEV_LAUNCH_CAMPAIGN`

IRREVERSIBLE EXTERNAL EFFECT: starts or resumes campaign sending and may immediately deliver queued messages. Starts sending a draft campaign, or a paused one again with the messages it had queued. This is the only route that makes a campaign send. It first runs the checks `GET /v1/campaigns/{campaignId}/readiness` reports and refuses with the first that fails, as `422` and its code, such as `campaign_has_no_steps` or `no_active_email_accounts`. Enrolling the people on the campaign's lists then runs in the background, so it answers `202`: follow it with `GET /v1/campaigns/{campaignId}`. Launching a running campaign changes nothing. Launching a paused campaign may first write its older AI messages again, which can take a minute: allow two minutes. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |
| `idempotency_key` | string | No | Names this operation, so a retry with the same key and body gets the first success again, marked `Idempotent-Replayed`, instead of running or charging twice. A mailbox's `password` is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (`4xx`) frees the key at once, so a corrected retry runs. After a server error (`5xx`), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers `409` `idempotency_in_progress`; after that, a send or import that may already have gone out answers `409` `idempotency_outcome_unknown` instead of running again. 1 to 255 visible ASCII characters, such as a UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List exclusions

**Slug:** `OUTBOUND_DEV_LIST_CAMPAIGN_EXCLUSIONS`

Your organization's exclusions, oldest first: the people lists and company lists whose people campaigns skip. When a campaign enrolls people from its lists (at launch, when a list is added to it, and, with `isDynamic`, as people join its lists), it skips everyone on an excluded people list and everyone whose company is on an excluded company list: the company their record is linked to, not a company name alone. Exclusions are checked only then: they do not stop people a campaign already enrolled, and they do not cover people added with `POST /v1/campaigns/{campaignId}/people`. `matchedPeopleCount` counts every check that skipped a person, so it grows faster than the people skipped: a campaign with `isDynamic` checks its lists again every 30 minutes. Exclusion calls have a limit of their own, 30 a minute and 2,000 a day. Free. **Scope:** campaigns. Read-only keys may call it.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List a campaign's leads

**Slug:** `OUTBOUND_DEV_LIST_CAMPAIGN_LEADS`

The people enrolled in a campaign, as leads: where each is in the sequence, what they did (opened, clicked, replied, accepted an invitation), the A/B variants they were given and the account that first wrote to them. `search` matches a name or a company. For the next page, send the page's `pagination.nextCursor` as `cursor`. Later pages keep the first page's `pageSize`; only a missing `nextCursor` marks the end. Send the same `search` with it. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | The `pagination.nextCursor` of the page before. Later pages keep the first page's size. |
| `search` | string | No | Only leads whose name or company contains this text, in any case. |
| `page_size` | integer | No | Items per page. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaigns

**Slug:** `OUTBOUND_DEV_LIST_CAMPAIGNS`

Return one filtered page of campaigns with lifecycle state, channels, associated lists, recipients, sends, and engagement totals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque next cursor from the previous page. Resend the same search, campaign_type, and status filters when continuing. |
| `search` | string | No | Only return campaigns whose name contains this text, case-insensitively. |
| `status` | string ("initializing" | "active" | "completed" | "stopped" | "paused_manual" | "initialization_failed") | No | Only return campaigns in this lifecycle state. |
| `page_size` | integer | No | Maximum campaigns to return on this page (1-100). |
| `campaign_type` | string ("manual" | "ai-generated") | No | Only return campaigns of this type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List a campaign's queue

**Slug:** `OUTBOUND_DEV_LIST_CAMPAIGN_SEND_QUEUE`

A campaign's messages in one state: `approval_required` (written by AI and waiting for your approval), `scheduled` (going out at `scheduledAt`), `sent`, `skipped`, `stopped` (declined) or `overwritten` (replaced by an edit). For the next page, send the page's `pagination.nextCursor` as `cursor`. Later pages keep the first page's `pageSize`; only a missing `nextCursor` marks the end. Send the same `status` and `channel` with it. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | The `pagination.nextCursor` of the page before. Later pages keep the first page's size. |
| `status` | string ("approval_required" | "scheduled" | "sent" | "skipped" | "stopped" | "overwritten") | Yes | The messages to list: `approval_required` (written by AI, waiting for your approval), `scheduled` (going out at `scheduledAt`), `sent`, `skipped`, `stopped` (declined) or `overwritten` (replaced by an edit). |
| `channel` | string ("email" | "linkedin_connection" | "linkedin_message" | "linkedin_visit" | "linkedin_like" | "inmail") | No | Only the messages of this channel. |
| `page_size` | integer | No | Items per page. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List a campaign's steps

**Slug:** `OUTBOUND_DEV_LIST_CAMPAIGN_STEPS`

The campaign's steps in the order they run, with their lanes: a step under a condition names it as `parentStepId`, with its lane as `branchKey`. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List campaign templates

**Slug:** `OUTBOUND_DEV_LIST_CAMPAIGN_TEMPLATES`

The organization's campaign templates, up to 100, each with its steps and schedule. Free. **Scope:** campaigns. Read-only keys may call it.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List a campaign's variables

**Slug:** `OUTBOUND_DEV_LIST_CAMPAIGN_VARIABLES`

The tokens a step's subject and body can use, filled in for each lead when its message is written: first the standard ones, such as `{Contact First Name}`, `{Contact Company}` and `{Sender Signature}`, then a `{Column: <name>}` token for each column of the campaign's lists. These are the names to write, exactly as listed. Other text in braces is not one of these variables and may be changed or removed when the message is written, so preview a step with `POST /v1/campaigns/{campaignId}/steps/{stepId}/preview` before you launch. The sender tokens take the name and signature of the mailbox or LinkedIn seat the message goes out from, so give every mailbox its sender `name` and `signature` with `PATCH /v1/accounts/email/{accountId}` before you launch. `{CTA Link}` is the campaign's `ctaLink`. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List company filter values

**Slug:** `OUTBOUND_DEV_LIST_COMPANY_FILTERS`

The values the company search filters take. Without `field`, one list per filter: `industries` for `industriesV2`, `linkedinIndustries` for `linkedinIndustries`, `crunchbaseIndustries` for `crunchbaseCategories`, `crunchbaseCategoryGroups` for `crunchbaseCategoryGroups`, `companyTags` for `tags`, `naicsCodes[].code` for `naicsCodes`, `countries[].apiCode` for `headquartersCountryCode` and `officeLocationsV2`, `accelerators[].acceleratorSlug` for `acceleratorsV2`, `fundingStages` for `stage`, `technologies` for `technologies`, `statuses` for `status` and `fortuneRankings` for `fortuneRankings`. Copy values exactly: they are case-sensitive. With `field`, that filter's entry, shaped as the people filters' are. Company names and places come from `GET /v1/companies/autocomplete`. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field` | string | No | One filter's values, by the filter's name. Without it, every filter's. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List a company's people

**Slug:** `OUTBOUND_DEV_LIST_COMPANY_PEOPLE`

Lists the people who work at one company, narrowed by people `filters` such as seniority or department when you send them. Send `company` as `POST /v1/companies/resolve` takes it. For the next page, send the same `company` and `filters` with the page's `pagination.nextCursor` as `cursor`. A company nothing matches answers `status` `not_found`, with no people, and costs nothing. **Price:** \$0.0001 per person returned. Before the search runs, `limit` times \$0.0001 is held from your balance, and what the page does not use is released. A page with nothing on it costs nothing. **Scope:** search. Read-only keys may call it. This action returns one page only; pass the response's pagination nextCursor back as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | People per page, up to 25. The page's most possible cost, `limit` times \$0.0001, is held from your balance first. |
| `cursor` | string | No | The `pagination.nextCursor` of the page before. Send it with the same search, as the `filters` the first page answered with. |
| `company` | object | Yes | The company, as `POST /v1/companies/resolve` takes it. Only the most precise of the values sent is looked up. |
| `filters` | object | No | People filters to narrow the company's people, such as seniority or department, from `GET /v1/people/filters`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversations

**Slug:** `OUTBOUND_DEV_LIST_CONVERSATIONS`

Return one filtered page of email threads or LinkedIn chats, newest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Only conversations with a message at or before this ISO 8601 date-time; must not be before since. |
| `since` | string | No | Only conversations with a message at or after this ISO 8601 date-time. |
| `cursor` | string | No | Opaque next cursor from the previous page; reuse the same filters. |
| `folder` | string ("inbox" | "sent" | "unread" | "favorite" | "archived" | "spam" | "trash") | No | Folder to list. LinkedIn supports inbox and unread; email also supports sent, favorite, archived, spam, and trash. |
| `search` | string | No | Text to match against the channel-specific conversation fields. |
| `channel` | string ("email" | "linkedin") | Yes | Conversation channel: email or linkedin. |
| `mailbox` | string | No | Email only: one mailbox or up to 20 comma-separated mailboxes. |
| `page_size` | integer | No | Maximum conversations on this page (1-100). |
| `account_id` | string | No | LinkedIn only: return conversations for this seat ID. |
| `campaign_id` | string | No | Only conversations belonging to this campaign ID. |
| `replies_only` | boolean | No | Email only: return only conversations where the other side replied. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List folders

**Slug:** `OUTBOUND_DEV_LIST_FOLDERS`

The organization's folders for people lists, or with `type=company`, for company lists. Every folder of the kind is listed at once. Free. **Scope:** lists. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("people" | "company") | No | The kind of list the folders hold: people (the default) or company. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List a hub's pages

**Slug:** `OUTBOUND_DEV_LIST_KNOWLEDGE_HUB_PAGES`

A hub's pages, with their content in Markdown: written from its sources (`generated`), changed since (`edited`), or added by hand (`user`). Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hub_id` | string | Yes | The knowledge hub's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List knowledge hubs

**Slug:** `OUTBOUND_DEV_LIST_KNOWLEDGE_HUBS`

The organization's knowledge hubs, the default first: what AI steps are written from, built from your websites and notes. Free. **Scope:** campaigns. Read-only keys may call it.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List a list's rows

**Slug:** `OUTBOUND_DEV_LIST_LIST_ROWS`

One page of a list's rows: people in a people list, companies in a company list, as `type` says. A row's `columnValues` holds the values of the list's own columns, by column id. For the next page, send the page's `pagination.nextCursor` as `cursor`. Later pages keep the first page's `pageSize`; only a missing `nextCursor` marks the end. Send the same `filters` and sort with it. `filters` narrows the rows: a JSON object in which a row must match every key, and any of a key's values. Text keys take an array of values or `{"include": [...], "exclude": [...]}`: `name`, `title`, `dept`, `level`, `industryName`, `country`, `state`, `personalLocation`, `companyName`, `companyIndustry`, `companyHeadQuartersCountry`, `companyLocation`, `website`, `campaignEngagement` and `otherLists` (the names of other lists). `numberOfEmployees` takes ranges written as strings, such as `"51-200"` Free. **Scope:** lists. Read-only keys may call it. Returns one page; pass pagination.nextCursor back as cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | The `pagination.nextCursor` of the page before. Later pages keep the first page's size. |
| `filters` | string | No | Only the rows that match: a JSON object of row filters, at most 8,000 characters, in the keys this route describes. |
| `list_id` | string | Yes | The list's id. |
| `sort_by` | string | No | The field to sort by. People lists: `firstName`, `lastName`, `jobTitle`, `createdAt`, `address.city`, `address.country`, a company field such as `company.name` or `company.linkedInHeadCount`, or `customColumns_<columnId>`. Company lists: `name`, `domain`, `industry`, `revenue`, `linkedInHeadCount` or `customColumns_<columnId>`. A field it does not know keeps the list's own order. |
| `page_size` | integer | No | Rows per page. |
| `sort_order` | string ("asc" | "desc") | No | The order `sortBy` sorts in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lists

**Slug:** `OUTBOUND_DEV_LIST_LISTS`

Return one filtered page of the organization's people or company lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque next cursor from the previous page. Resend the same filters and page size when continuing. |
| `search` | string | No | Only return lists whose name contains this text, case-insensitively. |
| `folder_id` | string | No | Only return lists in this folder. |
| `list_type` | string ("people" | "company") | No | Only return lists of this kind. |
| `page_size` | integer | No | Maximum lists to return on this page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List people filter values

**Slug:** `OUTBOUND_DEV_LIST_PEOPLE_FILTERS`

The filters the people search takes and the values each accepts, or one filter's with `field`. A free-text filter has no fixed values: its `autocomplete` is the `GET /v1/people/autocomplete` query that suggests them. `jobTitleRoleToSubRole` lists each department's sub-departments. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field` | string | No | One filter's values, by the filter's name. Without it, every filter's. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List prices

**Slug:** `OUTBOUND_DEV_LIST_PRICES`

The price of every billable item, in US dollars, and the version of the list. Free, for any key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List rate limits

**Slug:** `OUTBOUND_DEV_LIST_RATE_LIMITS`

Every rate limit the organization's calls share, with what is left of it in the current window, and the calling key's spend today against its daily cap. Free, with its own limit, so reading the limits never spends them.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List requests

**Slug:** `OUTBOUND_DEV_LIST_REQUESTS`

Every request of the last 30 days, newest first, with its status, time and cost. Filter by status class, route, key or time, or find one request by its id. A key without full access sees only its own requests. Free. This action returns one page only; pass the response's pagination nextCursor back as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | A request id, matched exactly. |
| `to` | string | No | Only requests made before this time, in ISO 8601. |
| `from_` | string | No | Only requests made at or after this time, in ISO 8601. |
| `cursor` | string | No | The `nextCursor` of the page before. |
| `endpoint` | string | No | Only requests to this route, as the requests name it. |
| `page_size` | integer | No | Requests per page. |
| `api_key_id` | string | No | Only this key's requests. A key without full access reads only its own. |
| `status_class` | string ("2xx" | "4xx" | "5xx") | No | Only requests answered with a status in this class. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List saved searches

**Slug:** `OUTBOUND_DEV_LIST_SAVED_SEARCHES`

The organization's saved searches, people and company alike, or one kind with `type`. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("people" | "company") | No | Only saved searches of this kind. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sending Accounts

**Slug:** `OUTBOUND_DEV_LIST_SENDING_ACCOUNTS`

List the organization's mailboxes and LinkedIn seats, including whether each can send, whether its sign-in works, mailbox capacity and warmup state. After using a LinkedIn sign-in link, poll this action with channel=linkedin until the seat is present and connected. Free and read-only; no account is changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("email" | "linkedin") | No | Return only email mailboxes or only LinkedIn seats. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List tracking domains

**Slug:** `OUTBOUND_DEV_LIST_TRACKING_DOMAINS`

Your organization's tracking domain: a hostname of your own, such as `go.fernway.co`, that the tracked links in your campaign emails go through instead of a shared link address, so the people you write to see your domain when they hover a link. An organization has at most one, and a deleted domain is not listed. With `activeOnly=true`, it is listed only while it is active. Its `status` is `pending_dns` while it waits for its CNAME record or its certificate and `verifying` while the hostname is set up, and it can pass through both more than once before it is `active`, the only state campaigns use it in. It is `failed` when it has not become active after about a day of checks, or when its setup was lost: check it again to start over. Tracking domain calls have a limit of their own, 30 a minute and 1,000 a day. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active_only` | boolean | No | Only an active tracking domain, the only kind campaigns use. False when left out, which also lists a domain that is not active yet or that failed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List ledger entries

**Slug:** `OUTBOUND_DEV_LIST_WALLET_TRANSACTIONS`

FULL-ACCESS API KEY REQUIRED; read-only and product-restricted keys cannot call this operation. Every change to the balance, newest first: top-ups, charges, refunds and adjustments, each with the balance after it. A charge names the key, route and request it paid for; a sending account's 30-day fee names the account and the 30 days it pays for (`accountFee`). Needs a key with full access. Free. This action returns one page only; pass the response's pagination nextCursor back as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("top_up" | "charge" | "refund" | "refund_reversal" | "adjustment" | "dispute" | "free_credit") | No | Only entries of this type. |
| `cursor` | integer | No | The `nextCursor` of the page before. |
| `page_size` | integer | No | Entries per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List writing styles

**Slug:** `OUTBOUND_DEV_LIST_WRITING_STYLES`

The organization's writing styles, the default first: `writingStyleId` on `POST /v1/campaigns` picks the one an `ai-generated` campaign follows. Free. **Scope:** campaigns. Read-only keys may call it.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause a campaign

**Slug:** `OUTBOUND_DEV_PAUSE_CAMPAIGN`

Stops a campaign from sending: its status becomes `stopped`, and its queued messages wait. Launch it again with `POST /v1/campaigns/{campaignId}/launch` to send them. While a launch or pause of the same campaign is running, it answers `409` `campaign_busy`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Mailbox

**Slug:** `OUTBOUND_DEV_PAUSE_MAILBOX`

Stop campaigns from sending through a mailbox by setting isActive false. The mailbox remains connected and its recurring connection fee is not stopped. Free, immediate, and not protected by an idempotency key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Mailbox address/ID to pause; case-insensitive, with @ literal or URL-encoded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Mailbox Warmup

**Slug:** `OUTBOUND_DEV_PAUSE_MAILBOX_WARMUP`

Pause recurring automated warmup email exchanges for a mailbox. This stops warmup traffic but does not pause campaign sending, disconnect the mailbox, or stop its recurring connection fee. A mailbox whose warmup never started is rejected. Free and not protected by an idempotency key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Mailbox address/ID whose automated warmup emails should pause. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview a step

**Slug:** `OUTBOUND_DEV_PREVIEW_CAMPAIGN_STEP`

SAFE PREVIEW: renders content only; it does not send any message or change campaign state. Writes a step for the first person on the campaign's lists, as they would get it, and answers it with that person. Nothing is saved or sent. A campaign with nobody to write for answers `422` `step_preview_unavailable`. It has its own limit too, 20 a minute and 300 a day. It answers once the writing is done, which can take a minute: allow two minutes. Free. **Scope:** campaigns. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | string | Yes | The step's id, from `GET /v1/campaigns/{campaignId}/steps`. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read a hub's website again

**Slug:** `OUTBOUND_DEV_REFRESH_KNOWLEDGE_HUB`

Reads one of a hub's websites again, in the background, and writes the pages that draw on it again. A site the hub does not have answers `404` `knowledge_hub_website_not_found`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | One of the hub's sites, as its `websites` list it. |
| `hub_id` | string | Yes | The knowledge hub's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rewrite a campaign's AI steps

**Slug:** `OUTBOUND_DEV_REGENERATE_CAMPAIGN_STEPS`

Writes the topic of every `ai_generated` step of the campaign again, from its knowledge hub. Messages already queued keep what they say. It has its own limit too, 10 a minute and 100 a day. It answers once the writing is done, which can take a minute: allow two minutes. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rewrite a hub's page

**Slug:** `OUTBOUND_DEV_REGENERATE_KNOWLEDGE_HUB_PAGE`

Writes a page again from the hub's sources, and answers it. A page written by hand has no sources: `409` `knowledge_page_not_regenerable`. It answers once the writing is done, which can take a minute: allow two minutes. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hub_id` | string | Yes | The knowledge hub's id. |
| `page_id` | string | Yes | The page's id, from `GET /v1/knowledge-hubs/{hubId}/pages`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove people from a list

**Slug:** `OUTBOUND_DEV_REMOVE_PEOPLE_FROM_LIST`

IRREVERSIBLE LIST MEMBERSHIP CHANGE: Removes the named people from this list. The people remain in the workspace and other lists. Takes people out of a list, by id, up to 5,000 a call. They stay in the workspace and in their other lists. An id that is not in the list is skipped. Free. **Scope:** lists, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | The list's id. |
| `person_ids` | array | Yes | People's ids, at most 5,000: the `id` of their rows in another list, or the `personIds` an upload answered with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename a folder

**Slug:** `OUTBOUND_DEV_RENAME_FOLDER`

Renames a folder. A name another folder for the same kind of list has answers `409` `folder_name_taken`. Free. **Scope:** lists, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The new name. |
| `folder_id` | string | Yes | The folder's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Conversation Reply

**Slug:** `OUTBOUND_DEV_REPLY_TO_CONVERSATION`

IRREVERSIBLE EXTERNAL COMMUNICATION: Send an email reply or LinkedIn chat message immediately through the conversation's mailbox or seat. This action does not create or save a draft, and a sent reply cannot be taken back.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | Email only: up to 50 addresses to copy. |
| `bcc` | array | No | Email only: up to 50 addresses to blind-copy. |
| `channel` | string ("email" | "linkedin") | Yes | Conversation channel: email or linkedin. |
| `content` | string | Yes | Reply content. Use HTML for email and plain text of at most 8,000 characters for LinkedIn. |
| `conversation_id` | string | Yes | Conversation ID returned by list conversations. |
| `idempotency_key` | string | No | Visible-ASCII operation key that enables deduplicated retries. Use a fresh key for a new reply. After a timeout, 5xx, or 429, retry the identical body only with the same key supplied on the original request. If omitted, do not automatically retry an ambiguous reply because the retry can duplicate it. |
| `in_reply_to_message_id` | string | No | Email only: messageId to answer; omit to answer the newest message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve a company

**Slug:** `OUTBOUND_DEV_RESOLVE_COMPANY`

Names one company from its `name`, website `domain` or `linkedinUrl`: its name, domain, LinkedIn page and logo. Send at least one. When several are sent, only the most precise is looked up: `linkedinUrl`, then `domain`, then `name`. A name resolves to the best-known company of that name, so send a domain for a common name. A company nothing matches answers `200` with `status` `not_found`, never a guess. Free. **Scope:** search. Read-only keys may call it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The company's name. |
| `domain` | string | No | The company's website domain. |
| `linkedin_url` | string | No | The company's LinkedIn page URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume a lead

**Slug:** `OUTBOUND_DEV_RESUME_CAMPAIGN_LEAD`

EXTERNAL EFFECT: resumes the lead and queues the next campaign message immediately when one is due. Starts a stopped lead's sequence again from where it stopped, whatever stopped it, an unsubscribe included, and queues its next message at once (`nextSend`). Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | string | Yes | The lead's `id` from `GET /v1/campaigns/{campaignId}/leads`, not its `personId`. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume Mailbox

**Slug:** `OUTBOUND_DEV_RESUME_MAILBOX`

Allow campaigns to send through a paused mailbox again. This can resume outbound campaign email activity immediately; review campaign state first. Free and not protected by an idempotency key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Mailbox address/ID to resume; case-insensitive, with @ literal or URL-encoded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke the calling key

**Slug:** `OUTBOUND_DEV_REVOKE_CALLING_KEY`

IRREVERSIBLE: This immediately revokes the calling API key. The current call succeeds, but every later use of that key is refused; create and connect a replacement key before calling if continued access is needed. Revokes the key that makes this call. This call succeeds; the key's next call is refused with `api_key_revoked`. Use it when a key may have leaked. Free, with its own limit, so a leaked key flooding other calls cannot block its own revoke.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run a saved search

**Slug:** `OUTBOUND_DEV_RUN_SAVED_SEARCH`

Runs a saved people search and returns one page of people, as `POST /v1/people/search` does with `savedSearchId`. The stored filters are the search: the body only pages it (`limit`, `cursor`) or narrows it to one person (`linkedinUrl`). Stored filters the search no longer takes are left out and listed in `ignoredFilterKeys`. A saved company search answers `422` `saved_search_type_mismatch`: run it with `POST /v1/companies/search` and `savedSearchId`. **Price:** \$0.0001 per person returned. Before the search runs, `limit` times \$0.0001 is held from your balance, and what the page does not use is released. A page with nothing on it costs nothing. **Scope:** search. Read-only keys may call it. This action returns one page only; pass the response's pagination nextCursor back as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | People per page. The page's most possible cost, `limit` times \$0.0001, is held from your balance first. |
| `cursor` | string | No | The `pagination.nextCursor` of the page before. Send it with the same search, as the `filters` the first page answered with. |
| `linkedin_url` | string | No | Narrow the saved search to one person, by LinkedIn profile URL. |
| `saved_search_id` | string | Yes | The saved search's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Companies

**Slug:** `OUTBOUND_DEV_SEARCH_COMPANIES`

Find one page of companies by plain-language criteria, structured filters, or a saved search. Continue a previous page only by passing its returned filters unchanged with its next_cursor as cursor. This paid action costs $0.0001 per returned company; each returned company costs $0.0001, and limit times $0.0001 is held before the request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum companies on this page (1-100). This amount times $0.0001 is held from the prepaid balance before the search; unused funds are released. |
| `query` | string | No | Plain-language description of companies to find. Provide exactly one of query, filters, saved_search_id, or saved_search_name for the first page. |
| `cursor` | string | No | Opaque next_cursor from the previous page. Resend that page's returned filters with it; omit it for the first page. |
| `filters` | object | No | Structured company filters using names and values from OUTBOUND_DEV_LIST_COMPANY_FILTERS and OUTBOUND_DEV_AUTOCOMPLETE_COMPANY_FILTER. Use as a first-page search selector, or pass the previous page's returned filters back unchanged with cursor for continuation. |
| `saved_search_id` | string | No | ID of a saved company search to run. Provide exactly one search selector. |
| `saved_search_name` | string | No | Exact title of a saved company search to run. A title shared by several saved searches is ambiguous. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search People

**Slug:** `OUTBOUND_DEV_SEARCH_PEOPLE`

Find one page of people by plain-language criteria, structured filters, a saved search, or LinkedIn profile. Continue a previous page only by passing its returned filters unchanged with its next_cursor as cursor. WARNING: This is a paid action. It costs $0.0001 per person returned, and limit times $0.0001 is held before the search; unused held funds are released and an empty page costs nothing. Results do not contain email addresses or phone numbers. Outbound may emit a next cursor longer than its own request limit, preventing continuation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum people on this page (1-100). Before the call, this value times $0.0001 is held from the balance. |
| `query` | string | No | Plain-language description of the people to find. For the first page, use at most one of query, filters, saved_search_id, or saved_search_name. |
| `cursor` | string | No | Opaque next cursor from the previous page. Pass it back unchanged and resend that page's returned filters. Outbound may return a cursor longer than its request limit; if it rejects that cursor, pagination cannot continue and the search must restart. |
| `filters` | object | No | Structured people filters using names and values from OUTBOUND_DEV_LIST_PEOPLE_FILTERS and OUTBOUND_DEV_AUTOCOMPLETE_PEOPLE_FILTER. Use as a first-page search selector, or pass the previous page's returned filters back unchanged with cursor for continuation. |
| `linkedin_url` | string | No | LinkedIn profile URL, in/<slug>, or bare slug. Use it alone to identify one person or with one search selector to narrow that search. |
| `saved_search_id` | string | No | ID of a saved people search to run. |
| `saved_search_name` | string | No | Exact title of a saved people search to run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send a step as a test email

**Slug:** `OUTBOUND_DEV_SEND_CAMPAIGN_STEP_TEST_EMAIL`

IRREVERSIBLE EXTERNAL EFFECT: sends a real test email to the specified recipient. Writes an email step for one person on the campaign's lists (`personId`, or the first one) and sends it to `toEmail` from one of your mailboxes. It is a real email: every call sends one. A step on another channel answers `422` `step_not_an_email`, and a mailbox that is not active and connected `422` `email_account_not_available`. It has its own limit too, 10 a minute and 100 a day. It answers once the writing is done, which can take a minute: allow two minutes. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | string | Yes | The step's id, from `GET /v1/campaigns/{campaignId}/steps`. |
| `to_email` | string | Yes | Where the test goes: any address. |
| `person_id` | string | No | The person the step is written for: someone on one of the campaign's lists. Left out, the first person of its first list. |
| `from_email` | string | No | The mailbox to send from: one of your active, connected mailboxes. Left out, the first active one the step can send from. |
| `campaign_id` | string | Yes | The campaign's id. |
| `idempotency_key` | string | No | Names this operation, so a retry with the same key and body gets the first success again, marked `Idempotent-Replayed`, instead of running or charging twice. A mailbox's `password` is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (`4xx`) frees the key at once, so a corrected retry runs. After a server error (`5xx`), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers `409` `idempotency_in_progress`; after that, a send or import that may already have gone out answers `409` `idempotency_outcome_unknown` instead of running again. 1 to 255 visible ASCII characters, such as a UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send LinkedIn Invitation

**Slug:** `OUTBOUND_DEV_SEND_LINKEDIN_INVITATION`

IRREVERSIBLE EXTERNAL COMMUNICATION: Immediately send a LinkedIn connection invitation from a connected seat, optionally with a note. This action does not create or save a draft, and a sent invitation cannot be taken back.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Optional note sent with the invitation; omit or pass an empty string for no note. |
| `account_id` | string | Yes | Connected LinkedIn seat ID to send from. |
| `linkedin_url` | string | Yes | LinkedIn profile URL of the person to invite. |
| `idempotency_key` | string | No | Visible-ASCII operation key that enables deduplicated retries. Use a fresh key for a new invitation. After a timeout, 5xx, or 429, retry the identical body only with the same key supplied on the original request. If omitted, do not automatically retry an ambiguous send because the retry can duplicate it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send New Message

**Slug:** `OUTBOUND_DEV_SEND_MESSAGE`

IRREVERSIBLE EXTERNAL COMMUNICATION: Start a new conversation by sending an email, LinkedIn message, or LinkedIn InMail. Email can be sent now or scheduled; LinkedIn sends immediately. This action does not create or save a draft, and a sent message cannot be taken back.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | Email only: up to 50 copied addresses. |
| `to` | array | No | Email only and required: one to 50 recipient addresses. |
| `bcc` | array | No | Email only: up to 50 blind-copied addresses. |
| `channel` | string ("email" | "linkedin") | Yes | Message channel: email or linkedin. |
| `content` | string | Yes | Message content. Use HTML for email and plain text of at most 8,000 characters for LinkedIn. |
| `in_mail` | boolean | No | LinkedIn only: send an InMail and spend a seat InMail credit. |
| `subject` | string | No | Required for email. For LinkedIn, an optional InMail-only subject of at most 200 characters. |
| `account_id` | string | No | LinkedIn only and required: connected seat ID to send from. |
| `from_address` | string | No | Email only and required: connected mailbox address to send from. |
| `linkedin_url` | string | No | LinkedIn only and required: profile URL of the recipient. |
| `scheduled_at` | string | No | Email only: ISO 8601 date-time to send; omit to send now. |
| `idempotency_key` | string | No | Visible-ASCII operation key that enables deduplicated retries. Use a fresh key for a new message. After a timeout, 5xx, or 429, retry the identical body only with the same key supplied on the original request. If omitted, do not automatically retry an ambiguous send because the retry can duplicate it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set the default knowledge hub

**Slug:** `OUTBOUND_DEV_SET_DEFAULT_KNOWLEDGE_HUB`

Makes a hub the one campaigns use when they name none. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hub_id` | string | Yes | The hub campaigns use when they name none. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Skip a queued message

**Slug:** `OUTBOUND_DEV_SKIP_QUEUED_SEND`

IRREVERSIBLE QUEUE EFFECT: permanently skips this queued message so it will not be sent. Skips one queued message, waiting for approval or scheduled: it is not sent, and its person moves on to their next step. Skipping a skipped message changes nothing and answers it again, `skipped`. Any other message, such as one that went out, was declined (`stopped`) or was replaced by an edit (`overwritten`), answers `409` `send_not_skippable`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `send_id` | string | Yes | The queued message's `id`, from `GET /v1/campaigns/{campaignId}/queue`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Mailbox Warmup

**Slug:** `OUTBOUND_DEV_START_MAILBOX_WARMUP`

STARTS RECURRING AUTOMATED EMAIL EXCHANGES: Start or resume mailbox warmup, which repeatedly sends warmup emails under the mailbox sender name to build provider trust. It is included at no extra charge but continues until paused or completed. A mailbox without a sender name is rejected. If Gmail requests an app password, supply it only on a retry and never log or expose it; it is used once and not retained. This operation has no idempotency-key support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Mailbox address/ID whose warmup should start or resume. |
| `app_password` | string | No | Google app password, only when a Gmail warmup start reports warmup_app_password_required. Treat it as a secret: never log, display, or expose it. Outbound uses it for one sign-in and does not retain it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop a lead

**Slug:** `OUTBOUND_DEV_STOP_CAMPAIGN_LEAD`

Stops one lead's sequence in a campaign: nothing more is sent to them from it. Stopping a stopped lead changes nothing. A lead the campaign does not have answers `404` `lead_not_found`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | string | Yes | The lead's `id` from `GET /v1/campaigns/{campaignId}/leads`, not its `personId`. |
| `campaign_id` | string | Yes | The campaign's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop a person in campaigns

**Slug:** `OUTBOUND_DEV_STOP_PERSON_CAMPAIGNS`

Stops one person's sequence in up to 50 campaigns, such as when they reply elsewhere. A campaign the organization does not have answers `404` `campaign_not_found`, and one the person is in none of answers `404` `person_not_in_campaign`; either way nothing is stopped. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_id` | string | Yes | The person's id: a lead's `personId`, not its `id`. |
| `campaign_ids` | array | Yes | 1 to 50 campaigns to stop the person in, each once. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a campaign

**Slug:** `OUTBOUND_DEV_UPDATE_CAMPAIGN`

Changes a campaign's settings: its name, start, sending days and time zone, lists and exclusions, tracking, daily limits and link. Send at least one; it answers the campaign as `GET /v1/campaigns/{campaignId}` does. New `listIds` replace the campaign's lists but enroll nobody in a running campaign: add a list with `POST /v1/campaigns/{campaignId}/lists` for that. While an `ai-generated` campaign's steps are still being written, new `listIds` answer `409` `campaign_initializing`. Click tracking cannot be turned off while a step waits for a click (`409` `click_tracking_required_by_condition`). Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | A new name. |
| `cta_link` | string | No | The link steps insert where they write `{CTA Link}`: an http or https URL, or null or empty for none. |
| `list_ids` | array | No | The campaign's lists, replacing the ones it has, 1 to 10. A running campaign does not enroll a new list's people: add a list with `POST /v1/campaigns/{campaignId}/lists` for that. |
| `timezone` | string | No | The IANA time zone the sending days and hours (9:00 to 17:00) are read in, such as `Europe/Lisbon`: a region, not an abbreviation such as EST. UTC when a campaign is created without one. |
| `email_days` | array | No | The days messages may go out, by English name with a capital first letter. Monday to Friday when left out. |
| `is_dynamic` | boolean | No | Enrolls people added to the campaign's lists after launch, as they arrive. False when left out. |
| `start_date` | string | No | When sending may start, as an ISO 8601 date-time. Now when left out. |
| `campaign_id` | string | Yes | The campaign's id. |
| `exclude_lists` | array | No | Up to 10 people lists whose people are never enrolled, matched by person, email address or LinkedIn profile. An id that is not one of your lists excludes nobody. |
| `daily_email_limit` | integer | No | The most emails the campaign sends a day, 1 to 10,000, or null for no limit. |
| `exclude_contacted` | string ("none" | "ever" | "last_1_month" | "last_3_months" | "last_6_months" | "last_1_year") | No | Skips people your campaigns already wrote to: `none` (the default) skips nobody, `ever` skips everyone written to, and `last_1_month` to `last_1_year` skip those written to in that time. |
| `add_unsubscribe_link` | boolean | No | Ends every email with a one-click unsubscribe link. True when left out. |
| `exclude_company_lists` | array | No | Up to 20 company or people lists: nobody who works at one of their companies is enrolled. A list the organization does not have answers `422` `exclude_company_lists_invalid`. |
| `exclude_engaged_contacts` | boolean | No | Skips people who replied to one of your campaigns. False when left out. |
| `click_tracking_enabled_at` | string | No | Turns click tracking on from this ISO 8601 date-time, or off with null. Off when left out. A step that waits for a click needs it on. |
| `daily_linkedin_message_limit` | integer | No | The most LinkedIn messages and InMails the campaign sends a day, 1 to 10,000, or null for no limit. |
| `open_rate_tracking_enabled_at` | string | No | Turns open tracking on from this ISO 8601 date-time, or off with null. Off when left out. |
| `daily_linkedin_connection_limit` | integer | No | The most LinkedIn invitations the campaign sends a day, 1 to 10,000, or null for no limit. |
| `send_only_to_validated_emails_enabled_at` | string | No | From this ISO 8601 date-time, enrolls only people whose email address checked `valid`; null also enrolls catch-all and unchecked addresses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a step

**Slug:** `OUTBOUND_DEV_UPDATE_CAMPAIGN_STEP`

Changes a step: a `manual` step's `subject` and `body` (sent together: they replace its whole message), an AI step's `topic`, the days it waits, or an A/B split's weights, at any time. A condition takes only `daysBetween`, its window of 1 to 30 days. It answers the step's id; read the step with `GET /v1/campaigns/{campaignId}/steps`. A new topic has the step's title written again before the answer. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | A `manual` step's new message, sent with `subject`. On a `linkedin_connection` step, the invitation note, up to 200 characters. |
| `topic` | string | No | What an AI step should say. Its title is written again from it. |
| `step_id` | string | Yes | The step's id, from `GET /v1/campaigns/{campaignId}/steps`. |
| `subject` | string | No | A `manual` step's new subject line, sent with `body`: the two replace the step's whole message. |
| `split_arms` | array | No | An A/B split's variants, its only field: both, `a` then `b`, with weights adding up to 100. Leads not yet written to follow the new weights. |
| `campaign_id` | string | Yes | The campaign's id. |
| `days_between` | integer | No | Days to wait after the step before, 0 to 365. On a condition, its window, 1 to 30, and the only field it takes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Conversation

**Slug:** `OUTBOUND_DEV_UPDATE_CONVERSATION`

Update one email conversation at its mail provider, or mark one LinkedIn chat read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string ("interested" | "not_interested") | No | Email only: label the newest received email, or explicitly pass null to remove both labels. |
| `channel` | string ("email" | "linkedin") | Yes | Conversation channel: email or linkedin. |
| `is_read` | boolean | No | Mark all messages read, or false to mark an email conversation unread. |
| `is_spam` | boolean | No | Email only: move to Spam, or false back to the inbox. |
| `is_deleted` | boolean | No | Email only: move to Trash, or false back to the inbox. |
| `is_archived` | boolean | No | Email only: move to Archived, or false back to the inbox. |
| `is_favorite` | boolean | No | Email only: star the conversation, or false to remove its star. |
| `conversation_id` | string | Yes | Conversation ID returned by list conversations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Conversations in Bulk

**Slug:** `OUTBOUND_DEV_UPDATE_CONVERSATIONS_BULK`

Apply one read, favorite, archive, spam, or trash change to 1-50 email conversations. HTTP 200 can include per-item failures, so inspect every result status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `is_read` | boolean | No | Mark every message read, or false to mark unread. |
| `is_spam` | boolean | No | Move each conversation to Spam, or false back to the inbox. |
| `is_deleted` | boolean | No | Move each conversation to Trash, or false back to the inbox. |
| `is_archived` | boolean | No | Move each conversation to Archived, or false back to the inbox. |
| `is_favorite` | boolean | No | Star each conversation, or false to remove its star. |
| `conversation_ids` | array | Yes | One to 50 unique email conversation IDs to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a knowledge hub

**Slug:** `OUTBOUND_DEV_UPDATE_KNOWLEDGE_HUB`

Renames a hub, or adds websites and notes to it and reads them in the background: it answers `202` with the hub as it was, and its pages follow. A website or note the hub has is replaced by what you send; nothing is removed. A hub still being built answers `409` `knowledge_hub_not_ready`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | A new name. |
| `notes` | array | No | 1 to 50 notes to add or replace, by `filename`. Nothing is removed. |
| `hub_id` | string | Yes | The knowledge hub's id. |
| `websites` | array | No | 1 to 20 sites to add, or to read again when the hub has them. A site the hub has is replaced by what you send, so `includeSubPages` and `isCompetitor` left out become false. Nothing is removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a hub's page

**Slug:** `OUTBOUND_DEV_UPDATE_KNOWLEDGE_HUB_PAGE`

Changes a page's title or content. A written page becomes `edited`, and is still written again when its sources change. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | A new title. |
| `hub_id` | string | Yes | The knowledge hub's id. |
| `content` | string | No | New Markdown, up to 60,000 characters. |
| `page_id` | string | Yes | The page's id, from `GET /v1/knowledge-hubs/{hubId}/pages`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a list

**Slug:** `OUTBOUND_DEV_UPDATE_LIST`

Renames a list, moves it into a folder, or both. Name the folder by id (`folderId`, or null to take the list out of every folder) or by name (`folderName`, which creates the folder when there is none). A folder holds one kind of list: a folder for the other kind answers `404` `folder_not_found`. Answers the list's id and what changed. Free. **Scope:** lists, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | A new name. |
| `list_id` | string | Yes | The list's id. |
| `folder_id` | string | No | Move the list into this folder, one for the list's own kind, or out of every folder with null. |
| `folder_name` | string | No | Move the list into the folder of this name, in any case, which is created when the list's kind has none. Send this or `folderId`, not both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit a queued message

**Slug:** `OUTBOUND_DEV_UPDATE_QUEUED_SEND`

Changes a message still waiting to go out: its subject, its body or when it is sent. The edit makes a new message: the answer's `id` is the new one's, and the message you named becomes `overwritten`. A message that already went out, or was skipped or declined, answers `409` `send_not_editable`. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | A new message, up to 20,000 characters, sent as written: tokens such as `{Contact First Name}` are filled in when a step's message is written, not in an edit. |
| `send_id` | string | Yes | The queued message's `id`, from `GET /v1/campaigns/{campaignId}/queue`. |
| `subject` | string | No | A new subject line, up to 500 characters. |
| `scheduled_at` | string | No | When to send it instead, as an ISO 8601 date-time in UTC. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a saved search

**Slug:** `OUTBOUND_DEV_UPDATE_SAVED_SEARCH`

Renames a saved search, replaces its filters, or both. Its kind cannot change. Free. **Scope:** search, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | A new title. |
| `filters` | object | No | New filters, replacing the old ones, in the saved search's own kind. |
| `saved_search_id` | string | Yes | The saved search's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Sending Account

**Slug:** `OUTBOUND_DEV_UPDATE_SENDING_ACCOUNT`

Update mailbox sender settings or LinkedIn sending limits/signature in place. Mailbox-only fields are name and daily_capacity; LinkedIn-only fields are daily_limits and weekly_limits. Unsupported channel fields are rejected. Free; changes affect future campaign sending and are not idempotency-key protected.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Mailbox sender name. LinkedIn seat names come from LinkedIn and cannot be changed here. |
| `channel` | string ("email" | "linkedin") | Yes | Account channel: email for a mailbox or linkedin for a LinkedIn seat. |
| `signature` | string | No | Mailbox HTML signature (up to 10000 characters) or LinkedIn plain text signature (up to 2000); empty removes it. |
| `account_id` | string | Yes | Mailbox address or LinkedIn seat ID to update. |
| `daily_limits` | object | No | LinkedIn daily invitations and messages, supplied together; each value 0-10000. |
| `weekly_limits` | object | No | LinkedIn weekly invitations and messages, supplied together; each value 0-10000. |
| `daily_capacity` | integer | No | Mailbox daily email capacity, 1-15. Start a mailbox under three months old at 5. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify an email address

**Slug:** `OUTBOUND_DEV_VERIFY_EMAIL`

Checks whether an email address can receive mail, without writing to it. `status` is the verdict: `valid`; `invalid`, which also covers addresses never to be written to (spam traps, abuse and do-not-mail addresses); `risky`, when the domain accepts mail for every address, so this one cannot be confirmed; or `unknown`, when no verdict could be had. A check takes a few seconds and ends within about 25 seconds. One that gets no verdict in time answers an empty `500` and costs nothing: try again. Verifications have their own limit, 60 a minute and 5,000 a day. **Price:** \$0.01 a verdict; `unknown` is free. The price is held from your balance before the check runs, and released when it gives no verdict or is refused. **Scope:** enrichment, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The address to check, such as `ana.costa@fernway.co`. It is checked trimmed and in lower case. |
| `idempotency_key` | string | No | Names this operation, so a retry with the same key and body gets the first success again, marked `Idempotent-Replayed`, instead of running or charging twice. A mailbox's `password` is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (`4xx`) frees the key at once, so a corrected retry runs. After a server error (`5xx`), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers `409` `idempotency_in_progress`; after that, a send or import that may already have gone out answers `409` `idempotency_outcome_unknown` instead of running again. 1 to 255 visible ASCII characters, such as a UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check a tracking domain now

**Slug:** `OUTBOUND_DEV_VERIFY_TRACKING_DOMAIN`

Checks the tracking domain now instead of at its next check, which runs every 5 minutes on its own, and answers the domain as the check left it: `pending_dns` or `verifying` while it is not live yet, `active` once it is. A `failed` domain gets another day of checks. An `active` domain is answered as it is, without a new check. To follow the status, read `GET /v1/tracking-domains` rather than calling this in a loop. Tracking domain calls have a limit of their own, 30 a minute and 1,000 a day. Adding, checking and deleting one also share a tighter one, 10 a minute and 200 a day. Free. **Scope:** campaigns, with a key that can write.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tracking_domain_id` | string | Yes | The tracking domain's id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
