Skip to content
Kirim Docs
Contacts

Create a contact

POST
/contacts
 
curl --request POST \
  --url https://api-kckit.kirim.chat/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "from": "example", "phone_number": "example", "name": "example", "email": "hello@example.com", "metadata": { "additionalProperty": "example" } }'

Create a contact attached to a connected WhatsApp account. Single-account orgs auto-resolve; multi-account orgs MUST pass from.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type application/json
object
from
string
/^\+[1-9]\d{6,14}$/
phone_number
required
string
/^\+[1-9]\d{6,14}$/
name
string
>= 1 characters <= 200 characters
email
string | null format: email
<= 255 characters
metadata
object
key
additional properties
Example generated
{
  "from": "example",
  "phone_number": "example",
  "name": "example",
  "email": "hello@example.com",
  "metadata": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Contact created

Media type application/json
object
data
required
object
id
required
string
object
required
string
Allowed values: contact
phone_number
required
string | null
name
required
string | null
email
required
string | null
metadata
required
object | null
whatsapp_account
required
object
phone_number
required
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
request_id
required
string
Example 
{
  "data": {
    "id": "ctc_01HXYZABCDEFGHJKMNPQRSTVWX",
    "object": "contact"
  }
}

400

Section titled “400 ”

Validation failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Section titled “401 ”

Authentication failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

422

Section titled “422 ”

Semantic failure (e.g. idempotency key reuse)

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}