Batch Create Contacts

POST

https://getrasl.io/api/v2/contacts/batch

Create multiple contacts in a single request. Runs inside a database transaction

Required Scope

contacts: write

Contact Object Fields

Each contact in the contacts array follows the same validation as the single create endpoint

Duplicate Detection

When options.skip_duplicates is true, the phone field is used as the unique identifier. Contacts with an existing phone number in the tenant will be skipped (not failed)

Response

Success (200 OK): Returns a summary of the batch operation with detailed results

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/jsonRequired

Example

{
    "contacts": [
        {
            "firstname": "string",
            "lastname": "string",
            "phone": "string",
            "type": "lead",
            "source_id": 0,
            "status_id": 0,
            "email": "user@example.com",
            "company": "string",
            "description": "string",
            "city": "string",
            "state": "string",
            "zip": "string",
            "address": "string",
            "country_id": 0,
            "assigned_id": 0
        }
    ],
    "options": {
        "continue_on_error": true,
        "skip_duplicates": false
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://getrasl.io/api/v2/contacts/batch' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contacts": [
        {
            "firstname": "string",
            "lastname": "string",
            "phone": "string",
            "type": "lead",
            "source_id": 0,
            "status_id": 0,
            "email": "user@example.com",
            "company": "string",
            "description": "string",
            "city": "string",
            "state": "string",
            "zip": "string",
            "address": "string",
            "country_id": 0,
            "assigned_id": 0
        }
    ],
    "options": {
        "continue_on_error": true,
        "skip_duplicates": false
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "summary": {
        "total": 0,
        "created": 0,
        "skipped": 0,
        "failed": 0
    },
    "created": [
        {
            "property1": "string",
            "property2": "string"
        }
    ],
    "skipped": [
        {
            "index": 0,
            "reason": "string",
            "data": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "errors": [
        {
            "index": 0,
            "data": {
                "property1": "string",
                "property2": "string"
            },
            "errors": {
                "property1": [
                    "string"
                ],
                "property2": [
                    "string"
                ]
            }
        }
    ]
}

🟠401UNAUTHORIZED

🟠403INSUFFICIENT_SCOPE

🟠403FEATURE_LIMIT_EXCEEDED

🟠404NOT_FOUND

🟠422VALIDATION_ERROR

🟠422WHATSAPP_NOT_CONFIGURED

🟠429RATE_LIMIT_EXCEEDED

🔴500INTERNAL_ERROR

Delete Contact

Batch Delete Contacts

Batch Create Contacts

Create multiple contacts in a single request. Runs inside a database transaction#

Required Scope#

Contact Object Fields#

Duplicate Detection#

Response#