Skip to main content
POST
/
customers
Create a new customer account
curl --request POST \
  --url https://api.example.com/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '"Acme Corp"'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corp",
  "sendingPhoneNumber": "+1234567890",
  "smsMessagingProfileId": "msg_prof_123",
  "smsBearerToken": "sms_token_xyz",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T12:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Customer name to create the account

The body is of type string.

Response

Customer successfully created

Represents a customer account within the Sent platform, including messaging channel configurations and credentials

​
id
string<uuid>

Unique identifier for the customer

​
name
string

Name of the customer organization

​
sendingPhoneNumber
string

Primary phone number used for sending messages

​
smsMessagingProfileId
string

Identifier for the SMS messaging profile

​
smsBearerToken
string

Bearer token for authenticating SMS requests

​
createdAt
string<date-time>

Timestamp when the customer account was created

​
updatedAt
string<date-time>

Timestamp when the customer account was last updated