Skip to content
Kirim Docs
Contacts

Attach or detach a label across many contacts

POST
/contacts/bulk_label
 
curl --request POST \
  --url https://api-kckit.kirim.chat/v1/contacts/bulk_label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "contact_ids": [ "example" ], "label_id": "example", "operation": "attach" }'

Apply or remove a label from up to 1000 contacts in a single transaction. Cross-org or team-mismatched contacts are silently skipped and counted.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type application/json
object
contact_ids
required
Array<string>
>= 1 items <= 1000 items
label_id
required
string
/^lbl_[0-9A-HJKMNP-TV-Z]{26}$/
operation
required
string
Allowed values: attach detach

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Bulk operation result

Media type application/json
object
data
required
object
applied
required
integer
skipped_cross_org
required
integer
skipped_team_mismatch
required
integer
request_id
required
string
Example generated
{
  "data": {
    "applied": 1,
    "skipped_cross_org": 1,
    "skipped_team_mismatch": 1
  },
  "request_id": "example"
}

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