Campaigns

Clone campaign (Create)

Duplicate an existing campaign, including its settings, into a new campaign.

When to use. Create a new campaign that starts from a copy of an existing one, instead of configuring every setting by hand.

Request body. campaign_id (required): the id of the campaign to copy. default_caller_id (optional): the caller ID to set on the new campaign.

Returns. { "campaigns": [ <campaign> ] } for the newly created campaign, with status 201. Returns 404 if the source campaign does not exist.

post/{sub_domain}/api/campaigns/clone

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/campaigns/clone
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

campaign_idinteger required

ID of the campaign to clone.

default_caller_idinteger nullable

Default caller ID for the cloned campaign (optional).

Response

Successful Response

total_campaignsinteger nullable

Number of campaigns in the response.

Example response

{
  "campaigns": [
    {
      "description": "Dialer Campaign",
      "id": 51,
      "name": "Dialer Campaign"
    }
  ]
}

Changes

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