/email/v_1/relational-campaign/create/

Create Relational Campaign

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Campaign name – a short, unique title used to identify the campaign in CallHub.

string

short description of the campaign

contact_list_ids
array of integers
required

List of Phonebook IDs that hold the contacts to text

contact_list_ids *
tag_ids
array of integers

UserTag IDs to filter contacts before sending.

tag_ids
integer

ID of a MediaFile (image/video) to attach as the campaign’s banner

string

Direct URL to a banner image if you don’t have a MediaFile ID

integer
initial_scripts
array of objects
required
initial_scripts*
survey_scripts
array of objects
required
survey_scripts*
integer
enum
required
Defaults to 1

MESSAGE = 1 CALL = 2 SHARE = 3

Allowed:
integer
enum
required
Defaults to 1

ALL=1 SELECTED = 2 TEAM = 3

Allowed:
selected_agents
array of integers

Explicit list of Agent IDs to use when agent_assignment_choice is not ALL

selected_agents
selected_team
array of integers

Explicit list of Team IDs to use when agent_assignment_choice is not ALL.

selected_team
string
required

Campaign start date ( YYYY‑MM‑DD )

string
required

Campaign start time (HH:MM:SS )

string
required

Campaign end date ( YYYY‑MM‑DD )

string
required

Campaign end time (HH:MM:SS )

string
Defaults to UTC

Timezone

Response
200
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!