POST

Emails.Add

Create an email/message draft row. This stores the message data; use send-specific routes when the account should actually send email. Business side effects follow this function workflow. This route does not add a separate app-level automation_event or socket_event unless those fields are returned in the JSON response.

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

  • Creates a Emails record or sends the requested data after validation.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

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
email
post
emailcustomer@example.comRecipient email address.

Optional Parameters

NameTypeSampleWhat it gives
subject
post
stringInvoiceEmail subject. If omitted, the message is saved without a subject.
message
post
stringHelloEmail body/message content.
client_id
post
int123Connects the draft to a customer.
file
post
json|string[]Attachment metadata when already uploaded.
father
post
int500Connects this draft as a reply/thread child.

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\/Emails.Add",
    "method": "POST",
    "body": {
        "email": "customer@example.com",
        "subject": "Invoice",
        "message": "Hello"
    },
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Emails.Add",
    "url_domain": "https:\/\/{domain}\/app\/Emails.Add"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "id": "501",
    "message": "Record added successfully."
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({});
// Fill body fields from the Sample Request JSON above.
const res = await fetch('/app/Emails.Add', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "No supported fields were sent."
}