POST
Campaigns.Activate
Activate a campaign, runs campaigns.activate.status, and emits realtime campaigns.activate.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.activate.status to users who should see this change.
Automation
Runs automation event campaigns.activate.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
| Name | Type | Sample | Explanation |
|---|---|---|---|
campaign_idpost | int | 123 | Campaign id. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
statuspost | int|string | 1 | Optional status/value field when this route supports it. |
customer_idpost | int | 456 | Customer 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.Activate",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"campaign_id": "123"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Campaigns.Activate",
"url_domain": "https:\/\/{domain}\/app\/Campaigns.Activate"
}Endpoint
POST /app/Campaigns.Activate
POST https://{user}.bull36.com/app/Campaigns.Activate
POST https://{domain}/app/Campaigns.ActivateSample Output
{
"success": 1,
"message": "Campaigns.Activate updated",
"id": "123",
"automation_event": "campaigns.activate.status",
"socket_event": "campaigns.activate.status"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('campaign_id', '123');
const res = await fetch('/app/Campaigns.Activate', { 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"
}