Skip to content
Kirimdev
Customers

Create a customer

POST
/customers
 
const url = 'https://api.kirimdev.com/v1/customers';
const options = {
  method: 'POST',
  headers: {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);
}

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type 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

Section titled “ Responses ”

200

Section titled “200 ”

Customer created

Media type application/json
object
data
required
object
id
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
string
Example 
{
  "data": {
    "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX",
    "object": "customer",
    "status": "pending"
  }
}

400

Section titled “400 ”

Validation failure

Media type 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

Section titled “401 ”

Authentication failure

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

402

Section titled “402 ”

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

Media type 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

Section titled “429 ”

Rate limit exceeded

Media type 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

Section titled “500 ”

Internal server error

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