Contacts

Create a contact

POST

/{phone_number_id}/contacts

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.kirimdev.com/v1/106540352242922/contacts"

  payload := strings.NewReader("{ \"phone_number\": \"example\", \"bsuid\": \"example\", \"username\": \"example\", \"name\": \"example\", \"email\": \"hello@example.com\", \"metadata\": { \"additionalProperty\": \"example\" } }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.kirimdev.com/v1/106540352242922/contacts';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"phone_number":"example","bsuid":"example","username":"example","name":"example","email":"hello@example.com","metadata":{"additionalProperty":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.kirimdev.com/v1/106540352242922/contacts";

    let payload = json!({
        "phone_number": "example",
        "bsuid": "example",
        "username": "example",
        "name": "example",
        "email": "hello@example.com",
        "metadata": json!({"additionalProperty": "example"})
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

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

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

Authorizations

bearerAuth

Parameters

Path Parameters

phone_number_id

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).

string

/^\d{6,20}$/

Example

106540352242922

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).

Request Body

application/json

object

phone_number

string

bsuid

string

/^[A-Z]{2}\.(ENT\.)?[A-Za-z0-9]{1,128}$/

username

string

>= 1 characters <= 100 characters

name

string

>= 1 characters <= 200 characters

email

string | null format: email

<= 255 characters

metadata

object

key

additional properties

Example ^generated

{
  "phone_number": "example",
  "bsuid": "example",
  "username": "example",
  "name": "example",
  "email": "hello@example.com",
  "metadata": {
    "additionalProperty": "example"
  }
}

Responses

200

Contact created

application/json

object

data

required

object

required

string

object

required

string

Allowed values: contact

phone_number

required

Phone number in E.164. NULL when the contact was created via BSUID (username-adopted user with no shared phone number). See docs/meta-docs/bsuid.md.

string | null

bsuid

required

Business-Scoped User ID. Populated by inbound webhooks or when the contact was created via BSUID. Format: {ISO alpha-2 country}.{alphanumeric ≤128}.

string | null

parent_bsuid

required

Parent BSUID (managed businesses only). Format: {ISO alpha-2 country}.ENT.{alphanumeric ≤128}.

string | null

username

required

WhatsApp username of the contact, if the user has adopted the username feature. Case-insensitive when comparing per Meta rules; . and _ are significant.

string | null

name

required

string | null

email

required

string | null

metadata

required

object | null

whatsapp_account

required

object

phone_number

required

string | null

phone_number_id

required

Meta business_phone_number_id — use as the {phone_number_id} path segment in /v1/{phone_number_id}/... endpoints.

string | null

customer

required

End-customer (multi-tenant platform mode) that owns this account. NULL for direct-org accounts.

object

required

string

name

required

string

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",
    "phone_number": "+628123456789",
    "bsuid": "US.13491208655302741918",
    "parent_bsuid": "US.ENT.11815799212886844830",
    "username": "pablomorales",
    "whatsapp_account": {
      "phone_number_id": "106540352242922",
      "customer": {
        "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
      }
    }
  }
}

400

Validation failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

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

Authentication failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

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

Resource not found

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

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

Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

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

Rate limit exceeded

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

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

Internal server error

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

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

Create a contact

Authorizations

Parameters

Path Parameters

Example

Request Body

Example generated

Responses

200

Example

400

Example

401

Example

404

Example

422

Example

429

Example

500

Example

Example ^generated