POST
/
campaign
/
update
/
{id}
curl --request POST \
  --url http://sandbox.mintlify.com/campaign/update/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "notes": "<string>",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "active",
  "campaign_type": "outbound",
  "contacts_list_source": [
    "<string>"
  ],
  "contacts_list_tags": [
    [
      "<string>"
    ]
  ],
  "contacts_list_categories": [
    [
      "<string>"
    ]
  ],
  "contacts_list_source_metadata": {},
  "agent_variables_contact_metadata_mapping": {},
  "ai_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "call_progress": 123,
  "call_time_of_day_from": "<string>",
  "call_time_of_day_to": "<string>",
  "number_of_call_attempts": [
    123
  ],
  "retry_delay": [
    123
  ],
  "retry_delay_unit": [
    "<string>"
  ],
  "days_of_week": [
    4
  ],
  "time_zone": "<string>",
  "inbound_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outbound_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "allow_non_local_calls": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-12-25",
  "ended_at": "2023-12-25",
  "webhook_mapping_variables": {},
  "webhook_mapping_variables_sources": {},
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "status": "ok",
  "message": "<string>",
  "data": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

ID of campaign to update

Body

application/json
Campaign update data
​
name
string
required

The name of the campaign

​
status
enum<string>
required

The current status of the campaign

Available options:
active,
paused,
completed
​
notes
string

Additional notes or description for the campaign

​
company_id
string

The ID of the company associated with the campaign

​
owner_user_id
string

The ID of the user who owns the campaign

​
campaign_type
enum<string>

The type of campaign

Available options:
outbound,
inbound
​
contacts_list_source
string[]

Sources of the contacts list

​
contacts_list_tags
array

Tags associated with the contacts list

​
contacts_list_categories
array

Categories associated with the contacts list

​
contacts_list_source_metadata
object

Metadata about the contacts list sources

​
agent_variables_contact_metadata_mapping
object

Mapping of agent variables to contact metadata

​
ai_agent_id
string

The ID of the AI agent associated with the campaign

​
call_progress
integer

The progress of the campaign

​
call_time_of_day_from
string

The start time for calls

​
call_time_of_day_to
string

The end time for calls

​
number_of_call_attempts
integer[]

Number of call attempts for each contact

​
retry_delay
integer[]

Delay between retry attempts

​
retry_delay_unit
string[]

Unit of the retry delay

​
days_of_week
integer[]

Days of the week when the campaign is active

​
time_zone
string

The time zone for the campaign

​
inbound_phone_number_id
string

The ID of the inbound phone number

​
outbound_phone_number_id
string

The ID of the outbound phone number

​
allow_non_local_calls
boolean

Whether non-local calls are allowed

​
created_at
string

Timestamp when the campaign was created

​
updated_at
string

Timestamp when the campaign was last updated

​
deleted_at
string | null

Timestamp when the campaign was deleted

​
started_at
string

The start date of the campaign

​
ended_at
string

The end date of the campaign

​
webhook_mapping_variables
object

Variables for webhook mappings

​
webhook_mapping_variables_sources
object

Sources for webhook mapping variables

​
webhook_id
string

The ID of the webhook associated with the campaign

Response

200 - application/json
Campaign updated
​
status
enum<string>
Available options:
ok,
error
​
message
string
​
data
string

Was this page helpful?