Create a New Contact

Add a new contact to your database

You can specify the contact type (lead or lustomer) assign them to groups, and include all relevant contact information.

Key Features

Automatic validation of contact data

Type classification (lead vs customer)

Group assignment with auto-creation of new groups

Source and status tracking

International phone and country support

WhatsApp Auto Lead Settings Integration: Automatic fallback to configured defaults

WhatsApp Auto Lead Fallback

When WhatsApp Auto Lead is enabled in your tenant settings the system will automatically provide default values for missing fields:

status_id: Uses the configured default lead status if not provided

source_id: Uses the configured default lead source if not provided

assignee: Uses the configured default assignee if not provided
This allows for simplified API calls where you only need to provide the essential contact information, and the system handles lead management defaults automatically.

Business Rules

Email must be unique within the tenant (if provided)

Phone numbers must be unique within the tenant

Groups will be auto-created if they don't exist

Contact creation counts towards your plan limits

Auto Lead fallback only applies when the feature is enabled in tenant settings

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Example

{
  "firstname": "Mahmoud",
  "lastname": "Elsayed",
  "company": "RASL",
  "type": "lead",
  "email": "mahmoud@example.com",
  "phone": "+201XXXXXXXXX",
  "source_id": 2,
  "status_id": 1,
  "description": "Potential client interested in premium services, contacted via website form",
  "country_id": 101,
  "assigned_id": 15,
  "groups": "VIP Customers,Newsletter Subscribers,Product Updates"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

Example

{
  "status": "success",
  "message": "Contact created successfully",
  "data": {
    "id": 25,
    "tenant_id": 13,
    "firstname": "Mahmoud",
    "lastname": "Elsayed",
    "company": "RASL",
    "type": "lead",
    "email": "mahmoud@example.com",
    "phone": "+201XXXXXXXXX",
    "source_id": 2,
    "status_id": 1,
    "description": "Potential client interested in premium services, contacted via website form",
    "country_id": 101,
    "assigned_id": 15,
    "addedfrom": 15,
    "created_at": "2024-02-08T14:30:25.000000Z",
    "updated_at": "2024-02-08T14:30:25.000000Z",
    "group_id": [
      1,
      2,
      3
    ]
  }
}

🟠400Bad Request

🟠401Unauthenticated

🟠422Validation Errors

Create a New Contact

Add a new contact to your database#

Key Features#

WhatsApp Auto Lead Fallback#