Customer.Add

Required Choice

Send at least one complete option from the list below.

Permissions

• User must be allowed to add customers.
• If folder_id is sent, user must be allowed to see this folder or be owner/manager in the organization.

Action

• Adds a customer to the Customers table.
• Checks if the customer already exists.
• Adds a log row with the new source.
• Saves source, affiliate, common fields, tags, folder/status, and custom fields from User.Basic.

Push Service

Pushes the added customer to team members that can see this customer.

Automation

Runs automation event add_lead with customer_id and submitted parameters such as source, folder_id, tag, affiliate, and custom fields.

Special Instructions

• If customer exists, response includes existing_customer_id and duplicate details.
• Send force=1 to create a new customer even when a duplicate exists.
• Use User.Basic for folders, statuses, tags, and custom field definitions.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Customer.Add",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "name": "John Demo",
        "phone": "0500000000",
        "source": "website",
        "affiliate": "partner-42",
        "folder_id": "1",
        "force": "0",
        "extra_fields": "{\"vip_level\":\"gold\"}"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Add",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Add"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "exists": 0,
    "is_new": 1,
    "forced": 0,
    "existing_customer_id": null,
    "duplicate_customer_id": null,
    "exists_by": null,
    "exists_reason": null,
    "duplicate_by": null,
    "duplicate_value": null,
    "duplicate_reason": null,
    "message": "Customer Created",
    "contactus_id": "123",
    "customer_id": "123",
    "id": "123"
}

Existing Customer Response

{
    "success": 0,
    "exists": 1,
    "is_new": 0,
    "message": "Customer already exists",
    "existing_customer_id": "123",
    "customer_id": "123",
    "duplicate_by": "email",
    "duplicate_value": "[email protected]",
    "duplicate_reason": "same email"
}

Fail Response

{
    "success": 0,
    "message": "Missing required parameter. Send at least one of name, phone, mobile, email, company_id."
}

JavaScript Example

const token = 'YOUR TOKEN';

// Load field settings once after login and build your form from them.
const basicRes = await fetch('/app/User.Basic', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` }
});
const basic = await basicRes.json();
const customerFields = basic.data.field_settings.customer.extra_fields;

const body = new URLSearchParams({
  name: 'John Demo',
  phone: '0500000000',
  source: 'website',
  affiliate: 'partner-42',
  folder_id: '1',
  checkUnique: 'email',
  glob_check_already_or_not: '1',
  force: '0',
  extra_fields: JSON.stringify({ vip_level: 'gold' })
});

// You may also send one custom field as cf-field_name when that key exists in User.Basic.
body.set('cf-vip_level', 'gold');

const res = await fetch('/app/Customer.Add', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});

const data = await res.json();
if (data.exists && !data.is_new) {
  console.log('customer already exists', {
    existing_customer_id: data.existing_customer_id || data.customer_id,
    duplicate_by: data.duplicate_by,
    duplicate_value: data.duplicate_value,
    duplicate_reason: data.duplicate_reason
  });
} else {
  console.log('created customer id', data.customer_id || data.id, { forced: data.forced, existing_customer_id: data.existing_customer_id });
}
console.log({ data, customerFields });

Error Example

{
    "success": 0,
    "exists": 1,
    "is_new": 0,
    "already": 1,
    "already_id": "123",
    "existing_customer_id": "123",
    "duplicate_customer_id": "123",
    "exists_by": "email",
    "exists_reason": "same email",
    "duplicate_by": "email",
    "duplicate_value": "[email protected]",
    "duplicate_reason": "same email",
    "customer_id": "123",
    "id": "123",
    "message": "Customer already exists"
}