​
Pause Campaign

​
Overview

This endpoint pauses a running campaign by its ID.

​
Endpoint Details

  • URL: /campaign/pause/{id}
  • Method: GET
  • Authentication: Required (API KEY)

​
Path Parameters

ParameterTypeRequiredDescription
idUUIDYesThe unique identifier of the campaign to resume.

​
Request Headers

HeaderValueDescription
AuthorizationBearer <api_key>Your API KEY

​
Example Request

    ​
    Response

    ​
    Success Response

    • Status Code: 200 OK
    {
  "status": "ok",
  "message": "ok",
  "data": "Success: Campaign Paused"
}

    ​
    Error Response

    • Status Code: 200 OK (with error message)
    When an error occurs in your endpoint, the server responds with an HTTP status code of 200 OK. However, the response body contains an error message in a structured format to indicate that something went wrong. This approach is sometimes used to standardize API responses, even for errors. 
    {
  "status": "error",
  "message": "error",
  "data": ""
}