Create a new customer

Do you need to add a new customer to your platform? Use POST {URI}/customers endpoint to create a new customer on this platform.

Endpoint	Purpose
`POST {URI}/customers`	Create a new customer on this platform.

Use the following query parameters with this endpoint to create a new customer on this platform:

Query params	Data type	Description
customerIdentifier	string	A unique identifier for this customer. It must be between 5-100 characters and accepts the following: 0-9, a-z, and A-Z in any sequence.
displayName	string	A friendly name for this customer. The string must be between 5-100 characters. Emojis are not accepted for `displayName` or any text entry.

The following payload is an example for this endpoint:

{
  "customerIdentifier": "string", (5-100 chars)
  "displayName": "string", (100 chars)
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

201 Created
400 Bad request
401 Unauthorized
403 Forbidden
409 Conflict, duplicate Exists
500 Internal Server Error
503 Service Unavailable