Skip to content
Kirim Docs
Contacts

Update a contact

PATCH
/contacts/{id}
 
curl --request PATCH \
  --url https://api-kckit.kirim.chat/v1/contacts/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "email": "", "metadata": "example" }'

Patch name, email, or metadata. Phone number is the identity column and cannot be changed via the API.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
/^ctc_[0-9A-HJKMNP-TV-Z]{26}$/

Request Body

Section titled “Request Body ”
Media type application/json
object
name
string | null
>= 1 characters <= 200 characters
email
Any of:
string format: email
<= 255 characters
metadata
object | null

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated contact

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"
  }
}

404

Section titled “404 ”

Resource not found

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"
  }
}