Outbound logo

Integrate Outbound with your AI CRM

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.

Explore Triggers and Actions

Add a list to a 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.

ActionTry it

Add a page to a hub

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.

ActionTry it

Add a step to a campaign

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.

ActionTry it

Add a 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...

ActionTry it

Add people to a 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.

ActionTry it

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.

ActionTry it

Add rows to a 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.

ActionTry it

Approve queued messages

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.

ActionTry it

Cancel a 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).

ActionTry it

Check a campaign is ready to launch

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.

ActionTry it

Check a tracking domain now

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.

ActionTry it

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.

ActionTry it

Connect Mailboxes in 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.

ActionTry it

Copy an A/B 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.

ActionTry it

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.

ActionTry it

Count Email Conversations

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

ActionTry it

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.

ActionTry it

Create a 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.

ActionTry it

Create a 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.

ActionTry it

Create a 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.

ActionTry it

Create Draft 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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Create List

Create an empty people or company list for organizing prospects.

ActionTry it

Decline queued messages

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.

ActionTry it

Delete a 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.

ActionTry it

Delete a 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.

ActionTry it

Delete a hub's page

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

ActionTry it

Delete a 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.

ActionTry it

Delete a 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.

ActionTry it

Delete a 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.

ActionTry it

Delete a 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.

ActionTry it

Delete an 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.

ActionTry it

Delete Campaign

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

ActionTry it

Delete List

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

ActionTry it

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.

ActionTry it

Duplicate a 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.

ActionTry it

Edit a queued message

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.

ActionTry it

Enrich a list's people

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.

ActionTry it

Enrich People in 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.

ActionTry it

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.

ActionTry it

Exclude a list from campaigns

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.

ActionTry it

Get a 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.

ActionTry it

Get a campaign's A/B 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.

ActionTry it

Get a campaign's 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.

ActionTry it

Get a 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.

ActionTry it

Get a 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.

ActionTry it

Get a saved search

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

ActionTry it

Get Conversation

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

ActionTry it

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.

ActionTry it

Get List

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

Get the balance

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.

ActionTry it

Get the 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.

ActionTry it

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.

ActionTry it

Launch a 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.

ActionTry it

List a campaign's 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.

ActionTry it

List a campaign's 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.

ActionTry it

List a campaign's 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.

ActionTry it

List a campaign's 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.

ActionTry it

List a company's 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.

ActionTry it

List a hub's 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.

ActionTry it

List a list's 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.

ActionTry it

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.

ActionTry it

List Campaigns

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

ActionTry it

List company filter values

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.

ActionTry it

List Conversations

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

ActionTry it

List 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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

List ledger entries

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.

ActionTry it

List Lists

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

ActionTry it

List people filter values

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.

ActionTry it

List prices

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Pause a 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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Preview a 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.

ActionTry it

Read a hub's website again

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.

ActionTry it

Remove people from a 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.

ActionTry it

Rename a 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.

ActionTry it

Resolve a 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.

ActionTry it

Resume a 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.

ActionTry it

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.

ActionTry it

Revoke the 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.

ActionTry it

Rewrite a campaign's AI 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.

ActionTry it

Rewrite a hub's 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.

ActionTry it

Run a 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.

ActionTry it

Save a campaign as a 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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Send a step as a 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.

ActionTry it

Send Conversation Reply

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.

ActionTry it

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.

ActionTry it

Send New 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.

ActionTry it

Set the default knowledge hub

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

ActionTry it

Skip a queued message

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.

ActionTry it

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.

ActionTry it

Stop a 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.

ActionTry it

Stop a person in 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.

ActionTry it

Suggest company filter values

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.

ActionTry it

Suggest people filter values

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.

ActionTry it

Update a 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.

ActionTry it

Update a hub's 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.

ActionTry it

Update a 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.

ActionTry it

Update a 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.

ActionTry it

Update a saved search

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

ActionTry it

Update a 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.

ActionTry it

Update Conversation

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

ActionTry it

Update Email Conversations in 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.

ActionTry it

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.

ActionTry it

Verify an email address

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.

ActionTry it

How the Outbound integration works

The Outbound integration connects your Dench AI CRM directly to Outbound, so agents can read and act on your Outbound data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.

119 actions are available for agents to invoke on your behalf. Every call runs through Outbound's own authorization, scoped to the account you connect.

Set up Outbound in Dench

  1. 1

    Sign in to your Dench workspace and open Integrations.

  2. 2

    Find Outbound and click Connect — you'll authorize access through Outbound's own sign-in flow. No API keys or code required.

  3. 3

    Ask an agent to use Outbound in chat, or call it from an automation.

  4. 4

    Manage or disconnect the connection any time from workspace settings.

Frequently asked questions

How does the Outbound integration work with Dench?

The Dench Outbound integration connects your AI CRM to Outbound, so AI agents can work with your Outbound data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.

What actions can AI agents perform with Outbound via Dench?

The Outbound integration currently exposes 119 actions, including Add a list to a campaign, Add a page to a hub, Add a step to a campaign, Add a tracking domain, Add people to a campaign, and Add People to List. Agents invoke them on your behalf from chat or from automations.

Do I need to write code to connect Outbound to Dench?

No. You connect Outbound from your Dench workspace using Outbound's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.

Is the Outbound integration secure?

Connections are authorized through Outbound's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the Outbound connection from your workspace settings at any time.