POST

Campaigns.Edit

Update a campaign. Validates campaign id and allowed fields, runs campaigns.edit.updated, and emits realtime campaigns.edit.updated.

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

  • Updates the requested Campaigns record after validating permissions and input fields.

Push Service

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

Automation

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

Required Parameters

NameTypeSampleExplanation
campaign_id
post
int123Campaign id.

Optional Parameters

NameTypeSampleWhat it gives
status
post
int|string1Optional status/value field when this route supports it.
customer_id
post
int456Customer id when this route connects a customer to this resource.

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.Edit",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "campaign_id": "123"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Campaigns.Edit",
    "url_domain": "https:\/\/{domain}\/app\/Campaigns.Edit"
}

Endpoint

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

Sample Output

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

JavaScript Example

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