Create a customer

POST /v1/customers

A business you send on behalf of. Assign numbers to it and its messages, verifications, events and usage carry its id. Optional; nothing requires customers.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Request body

JSON (Content-Type: application/json).

Field	Type	Required	Description
`name`	string	No	At most 200 characters. Nullable.
`external_id`	string	No	Your id for them; unique per account At most 200 characters. Nullable.
`metadata`	object	No	Up to 50 string values

Responses

Status	Meaning	Body
201	The customer	`Customer`
400	Invalid request	`Error`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
409	external_id already used	`Error`
429	Rate limit or quota exceeded	`Error`

201: `Customer` fields

Field	Type	Description
`id`	string	Example: `cus_a1B2c3D4e5F6g7`.
`object`	`customer`
`name`	string	Nullable.
`external_id`	string	Nullable.
`metadata`	object
`created_at`	string (date-time)
`updated_at`	string (date-time)
`phone_numbers`	array of string	Only on retrieve

Errors

Status	When
400	Invalid request
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
409	external_id already used
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X POST "https://api.joinsimplesms.com/v1/customers" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const customer = await sms.customers.create({ name: 'Acme Dental', externalId: 'acct_42' });

console.log(customer.id);

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

customer = client.customers.create(name="Acme Dental", external_id="acct_42")

print(customer["id"])