Create a contact
curl --request POST \
--url https://{domain}/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ada Lovelace",
"phone": "+15550100",
"email": "ada@example.com",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"opt_in_attested": true,
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "API",
"timezone": "Europe/London",
"tags": [
"VIP"
],
"custom_fields": {
"plan": "pro"
}
}
'import requests
url = "https://{domain}/api/v1/contacts"
payload = {
"name": "Ada Lovelace",
"phone": "+15550100",
"email": "ada@example.com",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"opt_in_attested": True,
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "API",
"timezone": "Europe/London",
"tags": ["VIP"],
"custom_fields": { "plan": "pro" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Ada Lovelace',
phone: '+15550100',
email: 'ada@example.com',
channel: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
opt_in_attested: true,
stage: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source: 'API',
timezone: 'Europe/London',
tags: ['VIP'],
custom_fields: {plan: 'pro'}
})
};
fetch('https://{domain}/api/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v1/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Ada Lovelace',
'phone' => '+15550100',
'email' => 'ada@example.com',
'channel' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'opt_in_attested' => true,
'stage' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source' => 'API',
'timezone' => 'Europe/London',
'tags' => [
'VIP'
],
'custom_fields' => [
'plan' => 'pro'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v1/contacts"
payload := strings.NewReader("{\n \"name\": \"Ada Lovelace\",\n \"phone\": \"+15550100\",\n \"email\": \"ada@example.com\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"opt_in_attested\": true,\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"API\",\n \"timezone\": \"Europe/London\",\n \"tags\": [\n \"VIP\"\n ],\n \"custom_fields\": {\n \"plan\": \"pro\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{domain}/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ada Lovelace\",\n \"phone\": \"+15550100\",\n \"email\": \"ada@example.com\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"opt_in_attested\": true,\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"API\",\n \"timezone\": \"Europe/London\",\n \"tags\": [\n \"VIP\"\n ],\n \"custom_fields\": {\n \"plan\": \"pro\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v1/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Ada Lovelace\",\n \"phone\": \"+15550100\",\n \"email\": \"ada@example.com\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"opt_in_attested\": true,\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"API\",\n \"timezone\": \"Europe/London\",\n \"tags\": [\n \"VIP\"\n ],\n \"custom_fields\": {\n \"plan\": \"pro\"\n }\n}"
response = http.request(request)
puts response.read_bodyContacts
Create a contact
Creates a contact and fires contact.created. To make it reachable on WhatsApp, supply channel (one of the workspace’s WhatsApp numbers), phone in international form and opt_in_attested: true, confirming the person agreed to receive WhatsApp messages from you; no other channel can be bound here. A number another contact already holds is refused. Subject to the workspace’s plan contact cap.
Required permission: salesbot:contacts:write
POST
/
contacts
Create a contact
curl --request POST \
--url https://{domain}/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ada Lovelace",
"phone": "+15550100",
"email": "ada@example.com",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"opt_in_attested": true,
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "API",
"timezone": "Europe/London",
"tags": [
"VIP"
],
"custom_fields": {
"plan": "pro"
}
}
'import requests
url = "https://{domain}/api/v1/contacts"
payload = {
"name": "Ada Lovelace",
"phone": "+15550100",
"email": "ada@example.com",
"channel": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"opt_in_attested": True,
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "API",
"timezone": "Europe/London",
"tags": ["VIP"],
"custom_fields": { "plan": "pro" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Ada Lovelace',
phone: '+15550100',
email: 'ada@example.com',
channel: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
opt_in_attested: true,
stage: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source: 'API',
timezone: 'Europe/London',
tags: ['VIP'],
custom_fields: {plan: 'pro'}
})
};
fetch('https://{domain}/api/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v1/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Ada Lovelace',
'phone' => '+15550100',
'email' => 'ada@example.com',
'channel' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'opt_in_attested' => true,
'stage' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source' => 'API',
'timezone' => 'Europe/London',
'tags' => [
'VIP'
],
'custom_fields' => [
'plan' => 'pro'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v1/contacts"
payload := strings.NewReader("{\n \"name\": \"Ada Lovelace\",\n \"phone\": \"+15550100\",\n \"email\": \"ada@example.com\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"opt_in_attested\": true,\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"API\",\n \"timezone\": \"Europe/London\",\n \"tags\": [\n \"VIP\"\n ],\n \"custom_fields\": {\n \"plan\": \"pro\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{domain}/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ada Lovelace\",\n \"phone\": \"+15550100\",\n \"email\": \"ada@example.com\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"opt_in_attested\": true,\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"API\",\n \"timezone\": \"Europe/London\",\n \"tags\": [\n \"VIP\"\n ],\n \"custom_fields\": {\n \"plan\": \"pro\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v1/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Ada Lovelace\",\n \"phone\": \"+15550100\",\n \"email\": \"ada@example.com\",\n \"channel\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"opt_in_attested\": true,\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"API\",\n \"timezone\": \"Europe/London\",\n \"tags\": [\n \"VIP\"\n ],\n \"custom_fields\": {\n \"plan\": \"pro\"\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
bearerAuthapiKeyHeader
A workspace API key: Authorization: Bearer osk_...
Body
application/json
Response
201
Created