Switchboard Platform Integrations

Convert a saved search into a phone list or email list. Creates an async job.

Add a single email contact to your Switchboard account.

Create a new label for organizing contacts.

Upload a phone list from a publicly accessible CSV file.

Create a draft copy of an existing form with a new ID.

Start an export of all broadcasts your organization has created. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of all email contacts your organization has created. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of the email messages sent in a specific email blast. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of inbox conversations (incoming text replies). Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of all phone contacts your organization has created. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of the phones and emails matching a saved search. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Pause a broadcast that is currently sending.

Re-evaluate a saved search to update its results.

Schedule a broadcast to be sent at a future time.

Send sample messages of a broadcast to one or more phone numbers to test how the message renders before sending it for real.

Configure a broadcast to automatically pause after a given number of messages have been sent.

Upload a CSV file to Switchboard and return an Upload ID. Use this before Bulk Update Phone Labels: stage the CSV here, then pass the returned Upload ID to that action.

Restore a previously archived shortlink domain.

Cancel a previously scheduled broadcast, returning it to draft status.

Add or remove labels from an email contact.

Update a form. Note: form_type, slug, and layout cannot be changed. Providing a Draft Schema replaces the entire editable schema.

Rename an existing label.

Add or remove labels from a phone contact.

Add or remove labels from all contacts in a phone list.

Update an existing saved search. Only the fields you provide are changed. Leave the filters blank to rename or re-describe without touching the criteria; set an Include Filter to replace the criteria.

Find a broadcast by ID or search by filter.

Find a canned (pre-written) response by ID, or search by filter.

Find a contribution dispute (chargeback) by ID, or search by filter.

Search for email contacts by filter.

List individual email messages for a specific email blast, showing recipient, delivery status, and timestamps.

Find an email sender identity by ID, or search by filter.

Find a form CSS template by ID, or list templates.

Find a form response (submission) by ID, or search by filter.

Find an asynchronous job by ID, or list recent jobs. Jobs track exports and other async operations.

Find a label by ID or search by filter.

Find a messaging client by ID, or search by filter.

Find an organization you have access to by ID, or search by filter.

List the transaction-level contributions, refunds, and fees that make up a specific payout (for reconciliation).

Find a phone list by ID or search by filter.

Find a recurring contribution (recurring donation series) by ID, or search by filter.

Find a custom shortlink domain by ID, or search by filter.

Preview how a broadcast message will appear to recipients. The broadcast must be in draft or scheduled status. (Beta)

Create a new broadcast for sending text messages to your phones.

Import an email list from a publicly accessible CSV file.

Add a single phone contact to your Switchboard account.

Create a copy of an existing form CSS template.

Start an export of the phone messages sent in a specific broadcast. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of all email blasts your organization has created. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of the emails in a specific email list. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of opted-out phone numbers. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of the phones in a specific phone list. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Start an export of unsubscribed email addresses. Creates an async job and returns a Job URL immediately — poll it with the Find Job search to retrieve the download (result) URL when the export completes.

Publish a form’s draft schema so it goes live.

Resume a broadcast that is currently paused.

Send an existing draft broadcast immediately.

Send a one-off message to a phone number that already exists in your organization. (Beta)

Set a shortlink domain as your organization’s primary domain.

Restore a previously archived phone list to the active lists view.

Remove a form’s published schema so it is no longer live.

Update an existing broadcast. Only the fields you provide are changed; omitted fields are left as-is. Which fields can be edited depends on the broadcast status (draft, scheduled, paused).

Add or remove labels from all contacts in an email list.

Update a form CSS template’s name or CSS. Only provided fields are changed.

Enable or disable sticky sender on a messaging client (10DLC clients only).

Update a phone list’s name, description, or acquisition cost. Only the fields you provide are changed.

Modify a recurring contribution. The API only allows reductions: a lower amount, or a less-frequent schedule. Changes take effect immediately, including the next scheduled charge.

Upload a media file for use in MMS broadcasts.

List individual phone messages for a specific broadcast, showing recipient, delivery status, and timestamps.

Find a contribution (donation) by ID, or search by filter.

Find a contributions payout by ID, or search by filter.

Find an email blast by ID or search by filter.

Find an email list by ID or search by filter.

Find a form by ID, or search by filter.

Retrieve performance metrics for a form: views, responses, emails/phones collected, and attributed donations.

Find an invoice by ID, or search by filter.

Find an automated-reply keyword by ID, or list keywords.

Find uploaded media by ID or search by filter.

List the NGPVAN / EveryAction database connections configured for your organization.

Find a saved payment method by ID, or list saved payment methods.

Find a phone contact by number or search by filter.

List all messages associated with a specific phone number in your organization. (Beta)

Find a saved search by ID or search by filter.

Find SQL mirror datasets in your organization. SQL mirror datasets are BigQuery datasets that mirror your Switchboard data for SQL-based analytics.

Verify your API credentials and view the organizations and roles associated with your account. Useful for multi-org API keys to discover organization IDs.