POST /v1/contacts

Crear un contacto

curl --request POST \
  --url https://api.keebai.com/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "channel": "<string>",
  "username": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "profile_pic": "<string>",
  "custom_fields": {}
}
'

import requests

url = "https://api.keebai.com/v1/contacts"

payload = {
    "user_id": "<string>",
    "channel": "<string>",
    "username": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "profile_pic": "<string>",
    "custom_fields": {}
}
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({
    user_id: '<string>',
    channel: '<string>',
    username: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    phone: '<string>',
    email: '<string>',
    profile_pic: '<string>',
    custom_fields: {}
  })
};

fetch('https://api.keebai.com/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.keebai.com/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([
    'user_id' => '<string>',
    'channel' => '<string>',
    'username' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'phone' => '<string>',
    'email' => '<string>',
    'profile_pic' => '<string>',
    'custom_fields' => [
        
    ]
  ]),
  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.keebai.com/v1/contacts"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"username\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"profile_pic\": \"<string>\",\n  \"custom_fields\": {}\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.keebai.com/v1/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"username\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"profile_pic\": \"<string>\",\n  \"custom_fields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.keebai.com/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  \"user_id\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"username\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"profile_pic\": \"<string>\",\n  \"custom_fields\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "contact": {
    "_id": "<string>",
    "user_id": "<string>",
    "custom_fields": {},
    "tags": [
      "<string>"
    ],
    "is_attended": true,
    "first_seen_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "channel_id": "<string>",
    "external_id": "<string>",
    "username": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "profile_pic": "<string>",
    "last_attended_at": "2023-11-07T05:31:56Z",
    "last_seen_at": "2023-11-07T05:31:56Z",
    "last_user_message_at": "2023-11-07T05:31:56Z",
    "last_bot_response_at": "2023-11-07T05:31:56Z",
    "last_agent_response_at": "2023-11-07T05:31:56Z"
  }
}

POST

contacts

Crear un contacto

curl --request POST \
  --url https://api.keebai.com/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "channel": "<string>",
  "username": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "profile_pic": "<string>",
  "custom_fields": {}
}
'

import requests

url = "https://api.keebai.com/v1/contacts"

payload = {
    "user_id": "<string>",
    "channel": "<string>",
    "username": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "profile_pic": "<string>",
    "custom_fields": {}
}
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({
    user_id: '<string>',
    channel: '<string>',
    username: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    phone: '<string>',
    email: '<string>',
    profile_pic: '<string>',
    custom_fields: {}
  })
};

fetch('https://api.keebai.com/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.keebai.com/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([
    'user_id' => '<string>',
    'channel' => '<string>',
    'username' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'phone' => '<string>',
    'email' => '<string>',
    'profile_pic' => '<string>',
    'custom_fields' => [
        
    ]
  ]),
  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.keebai.com/v1/contacts"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"username\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"profile_pic\": \"<string>\",\n  \"custom_fields\": {}\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.keebai.com/v1/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"username\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"profile_pic\": \"<string>\",\n  \"custom_fields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.keebai.com/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  \"user_id\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"username\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"profile_pic\": \"<string>\",\n  \"custom_fields\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "contact": {
    "_id": "<string>",
    "user_id": "<string>",
    "custom_fields": {},
    "tags": [
      "<string>"
    ],
    "is_attended": true,
    "first_seen_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "channel_id": "<string>",
    "external_id": "<string>",
    "username": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "profile_pic": "<string>",
    "last_attended_at": "2023-11-07T05:31:56Z",
    "last_seen_at": "2023-11-07T05:31:56Z",
    "last_user_message_at": "2023-11-07T05:31:56Z",
    "last_bot_response_at": "2023-11-07T05:31:56Z",
    "last_agent_response_at": "2023-11-07T05:31:56Z"
  }
}

Creates a contact. Two fields are mandatory: channel_type, and user_id — the identifier of the person inside that channel. On WhatsApp, user_id is the phone number without the leading +. The company and project are taken from your token and must not appear in the body. Sending them returns 400.

Most contacts create themselves: the first time someone writes to one of your channels, Keebai records them automatically. Use this endpoint when you need a contact to exist before the first message — seeding an import, or pre-creating a record so you can attach a CRM ticket to it.

Endpoint

POST https://api.keebai.com/v1/contacts

Required scope

contacts:write

Headers

Header	Required	Value
`Authorization`	Yes	`Bearer kbai_pk_<token>`
`Content-Type`	Yes	`application/json`

Body

Field	Type	Required	Description
`channel_type`	`string`	Yes	One of `web`, `whatsapp`, `whatsapp_qr`, `facebook`, `messenger`, `instagram`, `tiktok`, `telegram`, `email`, `phone`.
`user_id`	`string`	Yes	Identifier inside that channel. On WhatsApp, the `wa_id` (phone without `+`). Up to 255 characters.
`channel`	`string`	No	`ObjectId` of a specific channel. Without it the contact is bound only to the channel type.
`username`	`string`	No	Handle on the channel. Up to 200 characters.
`first_name`	`string`	No	Up to 200 characters.
`last_name`	`string`	No	Up to 200 characters.
`phone`	`string`	No	Phone number in E.164, with the `+`.
`email`	`string`	No	Valid email address.
`profile_pic`	`string`	No	HTTPS URL of the avatar.
`custom_fields`	`object`	No	Free-form object matching the custom fields configured for your company.

Example request

curl -X POST https://api.keebai.com/v1/contacts \
  -H "Authorization: Bearer kbai_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_type": "whatsapp",
    "user_id": "56912345678",
    "first_name": "Juan",
    "last_name": "Pérez",
    "phone": "+56912345678",
    "email": "juan@example.com"
  }'

const response = await fetch("https://api.keebai.com/v1/contacts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KEEBAI_API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    channel_type: "whatsapp",
    user_id: "56912345678",
    first_name: "Juan",
    last_name: "Pérez",
    phone: "+56912345678",
  }),
});
const { contact } = await response.json();

import os, requests

resp = requests.post(
    "https://api.keebai.com/v1/contacts",
    headers={"Authorization": f"Bearer {os.environ['KEEBAI_API_TOKEN']}"},
    json={
        "channel_type": "whatsapp",
        "user_id": "56912345678",
        "first_name": "Juan",
        "last_name": "Pérez",
        "phone": "+56912345678",
    },
    timeout=10,
)
resp.raise_for_status()
contact = resp.json()["contact"]

Response

201 Created

{
  "contact": {
    "_id": "65a1f2b3c4d5e6f7a8b9c0d1",
    "channel_type": "whatsapp",
    "user_id": "56912345678",
    "first_name": "Juan",
    "last_name": "Pérez",
    "phone": "+56912345678",
    "email": "juan@example.com",
    "custom_fields": {},
    "tags": [],
    "is_attended": false,
    "first_seen_at": "2026-05-02T14:31:07.221Z",
    "last_seen_at": "2026-05-02T14:31:07.221Z",
    "created_at": "2026-05-02T14:31:07.221Z",
    "updated_at": "2026-05-02T14:31:07.221Z"
  }
}

400 Bad Request

Missing channel_type or user_id, a channel_type outside the allowed set, a property the endpoint does not accept — including company and project — or a contact that already exists for that user_id and channel.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the contacts:write scope.

502 Bad Gateway

The messaging service could not complete the write.

Operational notes

A duplicate returns 400, not 409. Uniqueness is on user_id + channel within your company. Check with GET /v1/contacts first, filtering by phone or search, if a collision is plausible.
user_id is not the same as phone. On WhatsApp user_id is 56912345678 while phone is +56912345678. Getting this wrong creates a contact the inbound webhook will never match, so the same person shows up twice.
playground is not accepted as a channel_type — it is the internal test channel and is filtered out of every read.
first_seen_at and last_seen_at are stamped at creation, not left empty, so a seeded contact sorts as if it had just been active.

Authorizations

Authorization

string

header

required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Body

application/json

channel_type

enum<string>

required

Canal por el que existe el contacto. playground no se acepta en la API pública.

Available options:

web,

whatsapp,

whatsapp_qr,

facebook,

messenger,

instagram,

tiktok,

telegram,

email,

phone

user_id

string

required

Identificador del contacto dentro de ese canal. En WhatsApp es el wa_id (el teléfono sin +).

channel

string

ObjectId del canal concreto. Sin él, el contacto queda asociado sólo al tipo de canal.

username

string

first_name

string

last_name

string

phone

string

Teléfono en formato E.164

string

profile_pic

string

URL de la foto de perfil

custom_fields

object

Campos personalizados de la company

Response

201 - application/json

contact

object

required

Show child attributes

GET contacts/{id}PATCH contacts/{id}

Get started

Contacts

WhatsApp

WhatsApp Flows

Templates

Channels

POST /v1/contacts

Endpoint

Required scope

Headers

Body

Example request

Response

201 Created

400 Bad Request

401 Unauthorized

403 Forbidden

502 Bad Gateway

Operational notes

Authorizations

Body

Response

​Endpoint

​Required scope

​Headers

​Body

​Example request

​Response

​201 Created

​400 Bad Request

​401 Unauthorized

​403 Forbidden

​502 Bad Gateway

​Operational notes

Authorizations

Body

Response

Endpoint

Required scope

Headers

Body

Example request

Response

201 Created

400 Bad Request

401 Unauthorized

403 Forbidden

502 Bad Gateway

Operational notes