Using the Outreach Campaigns Call Request API

In the latest version of Smith.ai's Outreach Campaigns Request API, you can request an Outreach Campaigns call on-demand.

Here are a few examples of what can prompt our agents to make a call:

  • When a potential lead submits a web form on your site (with multiple follow-up attempts, if we don't reach them).
  • When a user performs a specific action in your application, such as requesting help or clicking a "book now" button in a live chat session.
  • To match an opportunity with a provider on your lead generation platform, using Smith.ai to bridge the communication.
  • With any Zapier Zap you can think of!

Accessing the API

To use the Smith.ai Outreach Campaigns Call Request API, you must generate an API key by following these instructions and also access your Campaign ID.

Building the API/Webhook Request

POST request to:

https://app.smith.ai/api/vr/v1/outbound/add-campaign-recipient/.

Authentication:

Add a query param to the POST request `?token=<your api access token>

POST payload fields:


"first_name": {

    "required": true

    "max_length": 256

    "description": "The first name of the recipient."

},

"last_name": {

    "required": true

    "max_length": 256

    "description": "The last name of the recipient."

},

    "phone_number": {

    "required": true

    "description": "The phone number of the recipient."

},

"email": {

    "required": false

    "max_length": 255

    "description": "The email address of the recipient."

},

"campaign": {

    “type”: “UUID”

    "required": true

    "description": "The campaign to which the recipient should be added."

},

Returns:

Success: 201 - created

Failure due to authentication issue: 403 - Invalid token/inactive user

Failure due to payload validation: 400 - Includes errors

Questions? Contact us!

If you're already a Smith.ai client and need help, please email us at support@smith.ai or call us at (650) 727-6484 for assistance.

If you're not yet a Smith.ai client, please schedule a free consultation to get started with our outreach campaigns or email us at sales@smith.ai. We'll help you select the best plan to match your business’s growth goals and budget.

How did we do?

Using the Outbound Call Request API

Contact