POST

Campaigns.Disable

Disable a campaign, runs campaigns.disable.status, and emits realtime campaigns.disable.status.

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Updates the requested Campaigns record after validating permissions and input fields.

Push Service

Pushes event campaigns.disable.status to users who should see this change.

Automation

Runs automation event campaigns.disable.status with the record id and submitted parameters after the action succeeds.

Special Instructions

  • Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
  • Send parameters as POST body fields exactly as documented.

Required Parameters

NameTypeSampleExplanation
campaign_id
post
int123Campaign id.

Optional Parameters

NameTypeSampleWhat it gives
status
post
int|string1Optional status/value field when this route supports it.
customer_id
post
int456Customer id when this route connects a customer to this resource.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Campaigns.Disable",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "campaign_id": "123"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Campaigns.Disable",
    "url_domain": "https:\/\/{domain}\/app\/Campaigns.Disable"
}

Endpoint

POST /app/Campaigns.Disable
POST https://{user}.bull36.com/app/Campaigns.Disable
POST https://{domain}/app/Campaigns.Disable

Sample Output

{
    "success": 1,
    "message": "Campaigns.Disable updated",
    "id": "123",
    "automation_event": "campaigns.disable.status",
    "socket_event": "campaigns.disable.status"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('campaign_id', '123');
const res = await fetch('/app/Campaigns.Disable', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Missing required parameter: campaign_id"
}