Contacts

Create a contact

Create a contact attached to the WhatsApp account identified by phone_number_id in the URL path.

post/{phone_number_id}/contacts

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/contacts
  • 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

phone_numberstring
bsuidstring
usernamestring
namestring
emailstring email nullable
metadataobject

Response

Contact created

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": {
    "id": "ctc_01HXYZABCDEFGHJKMNPQRSTVWX",
    "phone_number": "+628123456789",
    "bsuid": "US.13491208655302741918",
    "parent_bsuid": "US.ENT.11815799212886844830",
    "username": "pablomorales",
    "labels": [
      {
        "id": "lbl_01HXYZABCDEFGHJKMNPQRSTVWX",
        "name": "VIP"
      }
    ],
    "whatsapp_account": {
      "phone_number_id": "106540352242922",
      "customer": {
        "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
      }
    }
  },
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

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