POST

Campaigns.AddCustomer

Add a customer to 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.
  • The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Runs the Campaigns.AddCustomer function and returns JSON.

Push Service

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

Automation

Runs automation event campaigns.addcustomer.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.
  • On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
  • 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. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).

Authorization: Bearer YOUR TOKEN

Sample Request

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

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Campaigns.AddCustomer created",
    "id": "123",
    "automation_event": "campaigns.addcustomer.updated",
    "socket_event": "campaigns.addcustomer.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.AddCustomer', { 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"
}