Create a contact
curl --request POST \
--url https://api.watx.in/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "+919876543210",
"name": "Priya Nair",
"email": "priya@example.com",
"company": "Acme Traders",
"tags": [
"vip",
"newsletter"
]
}
'import requests
url = "https://api.watx.in/v1/contacts"
payload = {
"phone": "+919876543210",
"name": "Priya Nair",
"email": "priya@example.com",
"company": "Acme Traders",
"tags": ["vip", "newsletter"]
}
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({
phone: '+919876543210',
name: 'Priya Nair',
email: 'priya@example.com',
company: 'Acme Traders',
tags: ['vip', 'newsletter']
})
};
fetch('https://api.watx.in/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://api.watx.in/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([
'phone' => '+919876543210',
'name' => 'Priya Nair',
'email' => 'priya@example.com',
'company' => 'Acme Traders',
'tags' => [
'vip',
'newsletter'
]
]),
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://api.watx.in/v1/contacts"
payload := strings.NewReader("{\n \"phone\": \"+919876543210\",\n \"name\": \"Priya Nair\",\n \"email\": \"priya@example.com\",\n \"company\": \"Acme Traders\",\n \"tags\": [\n \"vip\",\n \"newsletter\"\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://api.watx.in/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"+919876543210\",\n \"name\": \"Priya Nair\",\n \"email\": \"priya@example.com\",\n \"company\": \"Acme Traders\",\n \"tags\": [\n \"vip\",\n \"newsletter\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.watx.in/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 \"phone\": \"+919876543210\",\n \"name\": \"Priya Nair\",\n \"email\": \"priya@example.com\",\n \"company\": \"Acme Traders\",\n \"tags\": [\n \"vip\",\n \"newsletter\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "<string>",
"instagram_username": "<string>",
"channels": [
"whatsapp"
],
"name": "<string>",
"email": "<string>",
"company": "<string>",
"avatar_url": "<string>",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"data": {
"id": "7e2d9c01-55b4-4a3d-9c8e-0f1a2b3c4d5e",
"phone": "+919876543210",
"instagram_username": null,
"channels": [
"whatsapp"
],
"name": "Priya Nair",
"email": "priya@example.com",
"company": "Acme Traders",
"avatar_url": null,
"tags": [
{
"id": "1b2c3d4e-5f60-4712-8293-a4b5c6d7e8f9",
"name": "vip",
"color": "#3b82f6"
}
],
"created_at": "2026-09-15T06:41:02.000Z",
"updated_at": "2026-09-15T06:41:02.000Z"
}
}{
"error": {
"code": "bad_request",
"message": "'to' must be a valid phone number in E.164 format (e.g. +14155550123)"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key"
}
}{
"error": {
"code": "bad_request",
"message": "'phone' is required"
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the 'messages:send' scope"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for this API key"
}
}Contacts
Create a contact
Creates a contact, or returns the existing one with the same phone
number. A new contact answers 201; a match answers 200. The phone
number is stored in E.164 form.
Requires the contacts:write scope.
POST
/
contacts
Create a contact
curl --request POST \
--url https://api.watx.in/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "+919876543210",
"name": "Priya Nair",
"email": "priya@example.com",
"company": "Acme Traders",
"tags": [
"vip",
"newsletter"
]
}
'import requests
url = "https://api.watx.in/v1/contacts"
payload = {
"phone": "+919876543210",
"name": "Priya Nair",
"email": "priya@example.com",
"company": "Acme Traders",
"tags": ["vip", "newsletter"]
}
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({
phone: '+919876543210',
name: 'Priya Nair',
email: 'priya@example.com',
company: 'Acme Traders',
tags: ['vip', 'newsletter']
})
};
fetch('https://api.watx.in/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://api.watx.in/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([
'phone' => '+919876543210',
'name' => 'Priya Nair',
'email' => 'priya@example.com',
'company' => 'Acme Traders',
'tags' => [
'vip',
'newsletter'
]
]),
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://api.watx.in/v1/contacts"
payload := strings.NewReader("{\n \"phone\": \"+919876543210\",\n \"name\": \"Priya Nair\",\n \"email\": \"priya@example.com\",\n \"company\": \"Acme Traders\",\n \"tags\": [\n \"vip\",\n \"newsletter\"\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://api.watx.in/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"+919876543210\",\n \"name\": \"Priya Nair\",\n \"email\": \"priya@example.com\",\n \"company\": \"Acme Traders\",\n \"tags\": [\n \"vip\",\n \"newsletter\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.watx.in/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 \"phone\": \"+919876543210\",\n \"name\": \"Priya Nair\",\n \"email\": \"priya@example.com\",\n \"company\": \"Acme Traders\",\n \"tags\": [\n \"vip\",\n \"newsletter\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "<string>",
"instagram_username": "<string>",
"channels": [
"whatsapp"
],
"name": "<string>",
"email": "<string>",
"company": "<string>",
"avatar_url": "<string>",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"data": {
"id": "7e2d9c01-55b4-4a3d-9c8e-0f1a2b3c4d5e",
"phone": "+919876543210",
"instagram_username": null,
"channels": [
"whatsapp"
],
"name": "Priya Nair",
"email": "priya@example.com",
"company": "Acme Traders",
"avatar_url": null,
"tags": [
{
"id": "1b2c3d4e-5f60-4712-8293-a4b5c6d7e8f9",
"name": "vip",
"color": "#3b82f6"
}
],
"created_at": "2026-09-15T06:41:02.000Z",
"updated_at": "2026-09-15T06:41:02.000Z"
}
}{
"error": {
"code": "bad_request",
"message": "'to' must be a valid phone number in E.164 format (e.g. +14155550123)"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key"
}
}{
"error": {
"code": "bad_request",
"message": "'phone' is required"
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the 'messages:send' scope"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for this API key"
}
}Authorizations
Your workspace API key, created in Settings → API keys, sent as
Authorization: Bearer <key>. New keys start with watx_live_; keys
issued before the rename start with converse360_live_ and still work.
Body
application/json
The phone number in E.164 form. A number without a country code is read using the workspace's default country.
Example:
"+919876543210"
Defaults to the phone number when omitted.
Tag names. A name the workspace does not have yet is created.
Response
A contact with this phone number already existed.
Show child attributes
Show child attributes