Remove Campaign Numbers

Remove phone numbers from a call campaign

PATCH /v2/admin/call-campaigns/remove-numbers/{campaignId}

Remove Campaign Numbers

cURL

curl --request PATCH \
  --url https://api.voxo.co/v2/admin/call-campaigns/remove-numbers/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "numbers": [
    "<string>"
  ]
}
'

200

{
  "status": "<string>",
  "message": "<string>",
  "campaignId": 123,
  "campaign": "<string>",
  "numbers": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId · number · required

Campaign ID

Required range: x > 0

Body

application/json

numbers · string[] · required

Phone numbers to remove

Pattern: ^[1-9]\d{9}$

purge · Option 1 · enum<number> Option 2 · enum<number>

Purge all numbers from campaign (1 = yes, 0 = no)

Available options: 1

Response

200

application/json

Numbers removed

status · string · required

Operation status

message · string · required

Status message

campaignId · number · required

Campaign ID

campaign · string · required

Campaign name

numbers · string[]

Numbers removed