POST

Campaigns.Add

Create a campaign. Validates the campaign name and allowed fields, runs campaigns.add.created, and emits realtime campaigns.add.created.

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

Creates a Campaigns record or sends the requested data after validation.

Push Service

Pushes event campaigns.add.created to users who should see this change.

Automation

Runs automation event campaigns.add.created 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.
Send date/time values in UTC Y-m-d H:i:s format when a date or datetime field is used.

Required Parameters

Name	Type	Sample	Explanation
`name` post	string	`Demo`	Campaign name.

Optional Parameters

Name	Type	Sample	What it gives
`status` post	int\|string	`1`	Optional status/value field when this route supports it.
`customer_id` post	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.Add",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "name": "Demo"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Campaigns.Add",
    "url_domain": "https:\/\/{domain}\/app\/Campaigns.Add"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Campaigns.Add created",
    "id": "123",
    "automation_event": "campaigns.add.created",
    "socket_event": "campaigns.add.created"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('name', 'Demo');
const res = await fetch('/app/Campaigns.Add', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Missing required parameter: name"
}