TRtryhamsa

Cancel a campaign

Cancels a running or scheduled campaign. Once cancelled, the campaign cannot be restarted.

post/v1/voice-agents/campaigns/{id}/cancel

Request

  • Base URL
    https://api.tryhamsa.com
  • URL
    https://api.tryhamsa.com/v1/voice-agents/campaigns/{id}/cancel
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required
Example:a8f7656f-098b-4c43-b165-7cfd2cc8ac50

UUID of the campaign.

Response

Successful response

successboolean
messagestring
messageKeystring

Example response

{
  "success": true,
  "message": "Operation completed successfully",
  "messageKey": "OPERATION_SUCCESSFUL"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.