Skip to content

Generate a campaign template for a company

GET
/voice/campaigns/templates

THIS COSTS CREDITS. Builds a multi-step campaign from a website.

Returns the steps with their prompts, waits and channels - a starting sequence, not a saved one. Nothing is created in the campaign builder by calling this.

Authorizations

Parameters

Query Parameters

customer_url
required

The company website to work from.

string

The company website to work from.

type_campaign

Which campaign shape to build.

string
default: AI ICP Campaign

Which campaign shape to build.

run_async

True returns a job id immediately (202) instead of waiting. Poll GET /voice/jobs/{job_id} for the result.

boolean

True returns a job id immediately (202) instead of waiting. Poll GET /voice/jobs/{job_id} for the result.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string