POST

Campaigns.RemoveCustomer

Remove a customer from a campaign after checking campaign/customer access, run campaign customer automation, and emit realtime campaign membership update.

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

  • Runs the Campaigns.RemoveCustomer function and returns JSON.

Push Service

Pushes event campaigns.removecustomer.updated to users who should see this change.

Automation

Runs automation event campaigns.removecustomer.updated 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.
customer_id
post
int456Customer id when this route connects a customer to this resource.

Optional Parameters

NameTypeSampleWhat it gives
status
post
int|string1Optional status/value field when this route supports it.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

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

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Campaigns.RemoveCustomer updated",
    "id": "123",
    "automation_event": "campaigns.removecustomer.updated",
    "socket_event": "campaigns.removecustomer.updated"
}

JavaScript Example

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