Customers

Create a customer

POST

/customers

package main

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

func main() {

  url := "https://api.kirimdev.com/v1/customers"

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

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

  req.Header.Add("Idempotency-Key", "order-20260910-0001")
  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/customers';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'order-20260910-0001',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"team_id":"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/customers";

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

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Idempotency-Key", "order-20260910-0001".parse().unwrap());
    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/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: order-20260910-0001' \
  --data '{ "team_id": "example", "name": "example", "email": "hello@example.com", "metadata": { "additionalProperty": "example" } }'

Create a new end-customer. Starts in pending status; transitions to active when the first WhatsApp account is connected via a setup link.

Authorizations

bearerAuth

Parameters

Header Parameters

Idempotency-Key

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.

string

Example

order-20260910-0001

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.

Request Body

application/json

object

team_id

string

>= 1 characters <= 64 characters

name

required

string

>= 1 characters <= 200 characters

email

string format: email

<= 255 characters

metadata

object

key

additional properties

Example ^generated

{
  "team_id": "example",
  "name": "example",
  "email": "hello@example.com",
  "metadata": {
    "additionalProperty": "example"
  }
}

Responses

200

Customer created

application/json

object

data

required

object

required

string

object

required

string

Allowed values: customer

name

required

string

email

required

string | null

status

required

string

Allowed values: pending active suspended archived

metadata

required

object | null

archived_at

required

string | null format: date-time

team_id

required

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

request_id

required

Unique request identifier to include when contacting support.

string

Example

{
  "data": {
    "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX",
    "object": "customer",
    "status": "pending"
  },
  "request_id": "req_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

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

A field value is invalid.

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_field_value",
    "message": "A field value is invalid.",
    "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

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

The provided API key is invalid.

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "The provided API key is invalid.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

402

Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.

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

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

Your trial has ended or subscription is inactive. Upgrade to continue.

{
  "error": {
    "type": "permission_error",
    "code": "subscription_inactive",
    "message": "Your trial has ended or subscription is inactive. Upgrade to continue.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

409

Conflict (e.g. template already exists, webhook subscription disabled, setup link inactive)

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

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

An identical request is still being processed. Retry later.

{
  "error": {
    "type": "conflict",
    "code": "idempotency_in_progress",
    "message": "An identical request is still being processed. Retry later.",
    "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

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

Idempotency-Key was reused with a different request body.

{
  "error": {
    "type": "invalid_request_error",
    "code": "idempotency_key_reuse",
    "message": "Idempotency-Key was reused with a different request body.",
    "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

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

Rate limit exceeded.

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded.",
    "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

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

An unexpected error occurred.

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

Create a customer

Authorizations

Parameters

Header Parameters

Example

Request Body

Example generated

Responses

200

Example

400

Examples

401

Examples

402

Examples

409

Examples

422

Examples

429

Examples

500

Examples

Example ^generated