MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Endpoints

POST api/v1/contacts

Example request:
curl --request POST \
    "http://localhost/api/v1/contacts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"wa_id\": \"b\",
    \"phone\": \"n\",
    \"name\": \"g\",
    \"email\": \"rowan.gulgowski@example.com\",
    \"language\": \"dl\"
}"
const url = new URL(
    "http://localhost/api/v1/contacts"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "wa_id": "b",
    "phone": "n",
    "name": "g",
    "email": "rowan.gulgowski@example.com",
    "language": "dl"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/contacts

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

wa_id   string     

Must not be greater than 32 characters. Example: b

phone   string  optional    

Must not be greater than 32 characters. Example: n

name   string  optional    

Must not be greater than 120 characters. Example: g

email   string  optional    

Must be a valid email address. Must not be greater than 180 characters. Example: rowan.gulgowski@example.com

language   string  optional    

Must be 2 characters. Example: dl

profile   object  optional    
custom_fields   object  optional