Campaigns.Remove

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

• Removes the requested Campaigns record when the user has permission.

Push Service

Pushes event campaigns.remove.deleted to users who should see this change.

Automation

Runs automation event campaigns.remove.deleted 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

Optional Parameters

No optional body parameters are defined for this function.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

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

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Campaigns.Remove removed",
    "id": "123",
    "automation_event": "campaigns.remove.deleted",
    "socket_event": "campaigns.remove.deleted"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('campaign_id', '123');
const res = await fetch('/app/Campaigns.Remove', { 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"
}