Campaigns

Duplicate a Campaign

Create a new campaign from an existing one

post/api/v2/powerdialer/campaign/{campaign_id}

Request

  • Base URL
    https://dialpad.com
  • URL
    https://dialpad.com/api/v2/powerdialer/campaign/{campaign_id}
  • Auth
    HTTP bearer

Path parameters

campaign_idstring required

ID of the campaign

Response

Default Response

author_dp_keystring nullable
author_idstring
author_keystring
caller_idstring nullable

The phone number to use as caller id or local_presence

campaign_group_idstring
campaign_group_keystring
campaign_group_orderinteger nullable

Sequential order for zero-priority members of the group

campaign_idstring required
company_idinteger required
date_archivedinteger
date_archived_isostring
date_audience_computedinteger
date_audience_computed_isostring
date_computedinteger
date_computed_isostring
date_createdinteger
date_created_isostring
date_endedinteger
date_ended_isostring
date_modifiedinteger
date_modified_isostring
date_pausedinteger
date_paused_isostring
date_scheduled_endinteger
date_scheduled_end_isostring
date_scheduled_startinteger
date_scheduled_start_isostring
date_startedinteger
date_started_isostring
descriptionstring

Description of Campaign

event_logs_gcs_filenamestring

GCS filename for campaign events on leads

flow_idstring
flow_keystring
gcs_filenamestring

GCS filename for campaign result

group_idinteger
idstring required
is_dynamicboolean

If the campaign should dynamically create lead list items from an audience

keystring required
lead_list_idstring
lead_list_keystring
namestring

Campaign name for display

num_itemsinteger

Number of lead items

num_pendinginteger

Number of pending lead items

office_idinteger nullable

office_id that owns this Campaign

priorityinteger nullable

Share (0-100) of group agent effort; 0 = deferred; None when ungrouped

progressnumber nullable

percent progress of campaign execution 0.0 - 1.0

settings_idstring
settings_keystring
shared_list_idstring
shared_list_keystring
sort_namestring nullable
state'pending' | 'launching' | 'scheduled' | 'active' | 'paused' | 'complete' | 'error' | 'deleted' | 'cancelled'
strategy'progressive' | 'predictive' | 'preview' | 'ai_progressive' | 'ai_predictive'

Dialing strategy for the campaign

target_idstring
target_keystring

Changes

No recorded changes to this operation across all 1 revision of this API.