/email/v_1/relational-campaign/create/

post

https://api.callhub.io/email/v_1/relational-campaign/create/

Create Relational Campaign

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

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

brief

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

banner_id

integer

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

banner_url

string

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

survey_id

integer

initial_scripts

array of objects

required

initial_scripts*

survey_scripts

array of objects

required

survey_scripts*

default_outreach_medium

integer

enum

required

Defaults to 1

MESSAGE = 1 CALL = 2 SHARE = 3

Allowed:

agent_assignment_choice

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

start_date

string

required

Campaign start date ( YYYY‑MM‑DD )

start_time

string

required

Campaign start time (HH:MM:SS )

end_date

string

required

Campaign end date ( YYYY‑MM‑DD )

end_time

string

required

Campaign end time (HH:MM:SS )

timezone

string

Defaults to UTC

Timezone

Response

200

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!