Create a customer record

Creates a customer record with information about a person or organization making Toast platform payments.

SecurityOAuth2
Request
header Parameters
Toast-Restaurant-External-ID
required
string <uuid>

The identifier of the location.

Example: 8dce2c23-283d-4a2a-8a11-d868a92a42d2
Request Body schema: application/json
description
required
string

A brief description of the customer, such as an email address, name, or phone number.

externalReferenceId
required
string

Represents the customer's identity in your integration. This can be the primary key for your customer, a unique UUID, an email address, or any other value.

Responses
200

Successful operation. Customer record created.

400

The request to create a customer record was not correctly formed or could not be processed successfully.

401

Your client is not authorized to use the API endpoint.

403

Your client is not authorized to use the API endpoint.

500

Internal server error.

post/v1/customers
Request samples
application/json
{
  • "externalReferenceId": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "id": "8dce2c23-283d-4a2a-8a11-d868a92a42d2",
  • "externalReferenceId": "338e8469-6d89-4b80-8da3-18c57cf52f2c",
  • "description": "Test Customer 1"
}