Campaigns
Get specific campaign
Retrieve a single campaign by its numeric id.
When to use. Drill-down to the full detail of one campaign, for example from a list row, or read its current settings before an update. Returns 404 if the id does not exist or is not visible to your API user.
Shape. { "campaigns": [ <campaign> ], "total_campaigns": 1 }, matching the list endpoint's envelope.
get/{sub_domain}/api/campaigns/{id}
Request
- Base URLhttps://api.commpeak.com/dialer
- URLhttps://api.commpeak.com/dialer/{sub_domain}/api/campaigns/{id}
- AuthAPI key in header Authorization
Path parameters
idinteger required
Campaign ID.
sub_domainstring required
Dialer Name (subdomain)
Response
Successful 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.