Skip to main content
POST
/
customers
cURL
curl --request POST \
  --url http://sandbox.mintlify.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1 (555) 123-4567",
  "document": "123.456.789-00"
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Dados para criação de cliente

​
name
string
required

The customer's full name or business name.

Example:

"John Doe"

​
email
string<email>
required

Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.

Example:

"john.doe@example.com"

​
phone
string

The customer's phone number.

Example:

"+1 (555) 123-4567"

​
document
string

The document number for the customer (e.g., SSN, Tax ID, etc.).

Example:

"123.456.789-00"

Response

Cliente criado com sucesso

⌘I