Skip to main content
POST
/
campaign-force-completed
Force complete campaign
curl --request POST \
  --url https://www.tryunleashx.com/api/v1/global/campaign-force-completed \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "campaign_id": 123,
  "campaign_status": "force_completed"
}
'
{
  "message": "<string>"
}
Use this endpoint to force complete a running campaign immediately, halting all pending audience calls.

​
Endpoint

POST /campaign-force-completed Content-Type: application/json Authentication: Required (workspace auth)

​
Request Body

{
  "campaign_id": 42,
  "campaign_status": "force_completed"
}
FieldTypeRequiredDescription
campaign_idnumberYesID of the campaign to update
campaign_statusstringYesTarget status as a string (see values below)

​
Campaign Status Values

ValueDescription
draftCampaign is in draft state
inprogressCampaign is actively running
holdCampaign is on hold
pauseCampaign is paused
force_completedImmediately halts all pending calls and marks campaign as completed
deletedMarks the campaign as deleted

​
Response

{
  "message": "Campaign force completed successfully"
}

​
Behavior

  • Maps the string campaign_status to its internal numeric code before processing.
  • When set to force_completed: all audience records with status fresh or inqueue are immediately set to halted.
  • This action is irreversible — the campaign cannot be resumed after force completion.

​
Example cURL

curl -X POST https://www.tryunleashx.com/api/v1/global/campaign-force-completed \
  -H "Content-Type: application/json" \
  -H "Authorization: <api_key>" \
  -d '{
    "campaign_id": 42,
    "campaign_status": "force_completed"
  }'

Headers

​
token
string
required

API token for authentication

Body

application/json
​
campaign_id
integer
required

ID of the campaign to force complete

​
campaign_status
enum<string>
required

Must be force_completed to mark as Force Completed

Available options:
force_completed

Response

Campaign force completed successfully

​
message
string