Update a contact

PATCH

/api/v1/contacts/{phone_number}

Request

Authorization

Add parameter in header

Authorization

Example:

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

Path Params

Body Params application/jsonRequired

Example

{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "language": "en",
    "metadata": {
        "source": "website",
        "location": "bangalore"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/api/v1/contacts/+919988776655' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "language": "en",
    "metadata": {
        "source": "website",
        "location": "bangalore"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": 1,
    "name": "Alfred Hitchcock",
    "phone_number": "+919988776655",
    "email": "alfred@example.com",
    "age": null,
    "gender": null,
    "language": "en",
    "nickname": null,
    "opted_out": false,
    "timezone": null,
    "metadata": {
        "source": "website",
        "location": "Bangalore"
    }
}

Modified at 2025-11-24 06:43:02

Create a contact

Create multiple contacts