Bulk update communication preferences

POST

/api/v1/contacts/bulk_update_communication_preferences

Update communication_preference for multiple contacts in one request. Capped at 1000 phone numbers per request and 30 requests per 60-second window per account.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "phone_numbers": [
        "9876543210",
        "+919876543211"
    ],
    "communication_preference": "mute_all"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/contacts/bulk_update_communication_preferences' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_numbers": [
        "9876543210",
        "+919876543211"
    ],
    "communication_preference": "mute_all"
}'

Responses

🟢200Success

application/json

All requested contacts were updated successfully.

Body

Example

{
    "updated_contacts": [
        {
            "id": 1,
            "name": "Alfred Hitchcock",
            "phone_number": "+919876543210",
            "email": "alfred@example.com",
            "age": null,
            "gender": null,
            "language": "en",
            "nickname": null,
            "opted_out": false,
            "communication_preference": "mute_all",
            "timezone": null,
            "metadata": {
                "source": "website"
            }
        }
    ],
    "errors": [],
    "total_requested": 1,
    "updated_count": 1,
    "error_count": 0
}

🟢207Partial Success

🟠422Parameter Error

🟠429Too Many Requests

Modified at 2026-04-21 12:14:00

Create a contact

Create an order