Delete campaign numbers
DELETE
/v1/accounts/{accountId}/campaigns/{campaignId}/numbersDeletes one or more numbers of a campaign, so they are not called.
Numbers are identified by the id of the campaign number objects, which is not the phone number itself: list the numbers first to get their IDs.
Only numbers that have not been called can be deleted, and the rules depend on the state of the campaign:
- Draft: numbers with
NotContactedstatus are deleted permanently. - Active or Paused (only
Dynamiccampaigns): numbers withNotContactedorRetryPendingstatus change toDeletedstatus. Pending retries are canceled.
Numbers with any other status are skipped.
Path parameters
accountIduuidRequired
ID of your SIP Caller account. See Account ID.
campaignIduuidRequired
ID of the campaign.
Request body
A JSON array with the IDs of the numbers to delete. The IDs can't be repeated.
Returns
Returns an array with the IDs of the deleted numbers. If no number was deleted, returns 404 Not Found.
DELETE
/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers
cURL
curl -X DELETE 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-H 'Content-Type: application/json' \
-d '[
1048201,
1048202
]'Response
200 OK
[
1048201,
1048202
]
