Skip to main content
POST
/
v1
/
voice-agents
/
campaigns
/
{id}
/
cancel
Cancel a campaign
curl --request POST \
  --url https://api.tryhamsa.com/v1/voice-agents/campaigns/{id}/cancel \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "message": "Operation completed successfully",
  "messageKey": "OPERATION_SUCCESSFUL"
}

Authorizations

​
Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Path Parameters

​
id
string<uuid>
required

UUID of the campaign.

Example:

"a8f7656f-098b-4c43-b165-7cfd2cc8ac50"

Response

Successful response

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully"

​
messageKey
string
Example:

"OPERATION_SUCCESSFUL"