Create a contact

POST

https://app.trypeach.io/api/v1/contacts

Create a contact

Request

Authorization

Add parameter in header

Authorization

Example:

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

Body Params application/json

Example

{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "phone_number": "+19019019191 or +919876543210",
    "metadata": {
        "source": "website",
        "location": "bangalore"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.trypeach.io/api/v1/contacts' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "phone_number": "+19019019191 or +919876543210",
    "metadata": {
        "source": "website",
        "location": "bangalore"
    }
}'

Responses

🟢201Created

application/json

Created a contact successfully

Body

Example

{
    "name": "Alfred Hitchcock",
    "language": "string",
    "email": "alfred@example.com",
    "phone_number": "+919988776655",
    "metadata": {
        "key": "value"
    }
}

🟠422Parameter Error

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

Update a contact

Bulk update communication preferences