Campaigns
Update Campaign
API Reference
Endpoints
- Actions
- Agents
- Call Now
- Calls
- Campaigns
- Chat
- Chat Widget
- Knowledge Base
- Dispositions
- Lead Lists
- Leads
- Mentions
- Phone Numbers
- Reports
- Roles
- Scripts
- Voices
- Webhooks
Campaigns
Update Campaign
PUT
/
v1
/
campaigns
/
{campaign_id}
curl --request PUT \
--url https://api.eqho.ai/v1/campaigns/{campaign_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"name": "<string>",
"status": "CREATED",
"agents": [
"<string>"
],
"rules": {
"call_limit": 123,
"call_window": [
{
"weekday": 1,
"start_time": 1179,
"end_time": 1179
}
],
"messenger_disposition_threshold_in_minutes": 123,
"medium_response_settings": {}
},
"dispositions": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"parent_disposition": "<string>",
"color": "<string>",
"contacted": true,
"conversion": true,
"enabled": true
}
],
"disposition_instructions": "<string>",
"call_transfer_phone_number": "<string>",
"tasks": [
{
"task_type": "try_again",
"task_settings": {},
"type": "post_call",
"condition": {
"call_count": [
123
],
"dispositions": [
{
"field": "twilio_status",
"values": [
"<string>"
]
}
]
},
"required": false
}
],
"call_now_threshold_recall_time": 123,
"external_context_template": "<string>",
"system_prompt": null,
"disable_system_dispositioning": true,
"campaign_duration": {
"campaign_start_date": "2023-11-07T05:31:56Z",
"campaign_end_date": "2023-11-07T05:31:56Z"
},
"disable_amd": true,
"custom_fields": {},
"initial_contact_medium": "web_voice"
}'
{
"_id": "<string>",
"name": "<string>",
"status": "CREATED",
"account_id": "<string>",
"agents": [
"<string>"
],
"phone_numbers": [
"<string>"
],
"inbound_phone_numbers": [
"<string>"
],
"claimed_phone_numbers": {},
"dispositions": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"parent_disposition": "<string>",
"color": "<string>",
"contacted": true,
"conversion": true,
"enabled": true
}
],
"disposition_instructions": "<string>",
"disposition_level_2_instructions": "<string>",
"rules": {
"call_limit": 123,
"call_window": [
{
"weekday": 1,
"start_time": 1179,
"end_time": 1179
}
],
"messenger_disposition_threshold_in_minutes": 123,
"medium_response_settings": {}
},
"enabled": true,
"history": {
"revision": 0,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "unknown",
"last_modified_at": "2023-11-07T05:31:56Z",
"last_modified_by": "unknown"
},
"call_transfer_phone_number": "<string>",
"tasks": [
{
"task_type": "try_again",
"task_settings": {},
"type": "post_call",
"condition": {
"call_count": [
123
],
"dispositions": [
{
"field": "twilio_status",
"values": [
"<string>"
]
}
]
},
"required": false
}
],
"call_now_threshold_recall_time": 123,
"external_context_template": "<string>",
"system_prompt": {
"inbound": {
"sections": [
{
"title": "<string>",
"description": "<string>"
}
],
"conversation_seeder": [
"<string>"
],
"structured_conversation_seeder": [
{
"role": "system",
"content": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {}
}
]
}
],
"type": "outbound",
"medium": "web_voice",
"extend_sections": false,
"extend_conversation_seeder": false
},
"outbound": {
"sections": [
{
"title": "<string>",
"description": "<string>"
}
],
"conversation_seeder": [
"<string>"
],
"structured_conversation_seeder": [
{
"role": "system",
"content": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {}
}
]
}
],
"type": "outbound",
"medium": "web_voice",
"extend_sections": true,
"extend_conversation_seeder": true
}
},
"disable_system_dispositioning": true,
"campaign_duration": {
"campaign_start_date": "2023-11-07T05:31:56Z",
"campaign_end_date": "2023-11-07T05:31:56Z"
},
"disable_amd": true,
"custom_fields": {},
"a2p_status": "rejected",
"initial_contact_medium": "web_voice",
"precall_tasks_execution_mode": "prolonged_ringing"
}
Authorizations
Path Parameters
Body
application/json
A set of optional updates to be made to a document.
Response
200
application/json
Successful Response
Container for a single campaign record.
Was this page helpful?
curl --request PUT \
--url https://api.eqho.ai/v1/campaigns/{campaign_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"name": "<string>",
"status": "CREATED",
"agents": [
"<string>"
],
"rules": {
"call_limit": 123,
"call_window": [
{
"weekday": 1,
"start_time": 1179,
"end_time": 1179
}
],
"messenger_disposition_threshold_in_minutes": 123,
"medium_response_settings": {}
},
"dispositions": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"parent_disposition": "<string>",
"color": "<string>",
"contacted": true,
"conversion": true,
"enabled": true
}
],
"disposition_instructions": "<string>",
"call_transfer_phone_number": "<string>",
"tasks": [
{
"task_type": "try_again",
"task_settings": {},
"type": "post_call",
"condition": {
"call_count": [
123
],
"dispositions": [
{
"field": "twilio_status",
"values": [
"<string>"
]
}
]
},
"required": false
}
],
"call_now_threshold_recall_time": 123,
"external_context_template": "<string>",
"system_prompt": null,
"disable_system_dispositioning": true,
"campaign_duration": {
"campaign_start_date": "2023-11-07T05:31:56Z",
"campaign_end_date": "2023-11-07T05:31:56Z"
},
"disable_amd": true,
"custom_fields": {},
"initial_contact_medium": "web_voice"
}'
{
"_id": "<string>",
"name": "<string>",
"status": "CREATED",
"account_id": "<string>",
"agents": [
"<string>"
],
"phone_numbers": [
"<string>"
],
"inbound_phone_numbers": [
"<string>"
],
"claimed_phone_numbers": {},
"dispositions": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"parent_disposition": "<string>",
"color": "<string>",
"contacted": true,
"conversion": true,
"enabled": true
}
],
"disposition_instructions": "<string>",
"disposition_level_2_instructions": "<string>",
"rules": {
"call_limit": 123,
"call_window": [
{
"weekday": 1,
"start_time": 1179,
"end_time": 1179
}
],
"messenger_disposition_threshold_in_minutes": 123,
"medium_response_settings": {}
},
"enabled": true,
"history": {
"revision": 0,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "unknown",
"last_modified_at": "2023-11-07T05:31:56Z",
"last_modified_by": "unknown"
},
"call_transfer_phone_number": "<string>",
"tasks": [
{
"task_type": "try_again",
"task_settings": {},
"type": "post_call",
"condition": {
"call_count": [
123
],
"dispositions": [
{
"field": "twilio_status",
"values": [
"<string>"
]
}
]
},
"required": false
}
],
"call_now_threshold_recall_time": 123,
"external_context_template": "<string>",
"system_prompt": {
"inbound": {
"sections": [
{
"title": "<string>",
"description": "<string>"
}
],
"conversation_seeder": [
"<string>"
],
"structured_conversation_seeder": [
{
"role": "system",
"content": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {}
}
]
}
],
"type": "outbound",
"medium": "web_voice",
"extend_sections": false,
"extend_conversation_seeder": false
},
"outbound": {
"sections": [
{
"title": "<string>",
"description": "<string>"
}
],
"conversation_seeder": [
"<string>"
],
"structured_conversation_seeder": [
{
"role": "system",
"content": "<string>",
"tool_calls": [
{
"name": "<string>",
"arguments": {}
}
]
}
],
"type": "outbound",
"medium": "web_voice",
"extend_sections": true,
"extend_conversation_seeder": true
}
},
"disable_system_dispositioning": true,
"campaign_duration": {
"campaign_start_date": "2023-11-07T05:31:56Z",
"campaign_end_date": "2023-11-07T05:31:56Z"
},
"disable_amd": true,
"custom_fields": {},
"a2p_status": "rejected",
"initial_contact_medium": "web_voice",
"precall_tasks_execution_mode": "prolonged_ringing"
}