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.
- 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.
- Send parameters as POST body fields exactly as documented.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
campaign_idpost | int | 123 | Campaign id. |
customer_idpost | int | 456 | Customer id when this route connects a customer to this resource. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
statuspost | int|string | 1 | Optional 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.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.AddCustomerSample 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"
}