Contacts

Attach or detach a label across many contacts

Apply or remove a label from up to 1000 contacts in a single transaction. Contacts not owned by the path-scoped account are silently skipped and counted under skipped_cross_org.

post/{phone_number_id}/contacts/bulk_label

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/contacts/bulk_label
  • Auth: HTTP bearer

Path parameters

phone_number_idstring required

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

Example:106540352242922

Headers

Idempotency-Keystring

Optional retry key. Reusing the same key with the same method, path, and body within 24 hours returns the original response; reusing it for a different request returns 422.

Example:order-20260910-0001

Request body

contact_idsstring[] required
label_idstring required
operation'attach' | 'detach' required

Response

Bulk operation result

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.