v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB

Customer

Create Customer

Create customer in a tenant.

For adding a customer to a tenant the authenticated user must have 'Create Customer' permission.

To also create an account for the key contact, you need to have the specific entitlements.

post/customers

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Request body

namestring required

The name of the customer.
Unsupported characters in the name: \ / : * ? " < > |

locationstring

The identifier of the parent folder for the customer.

firstNamestring

Key contact first name. If you provide this field, pleaase also provide email and last name

lastNamestring

Key contact last name. If you provide this field, pleaase also provide email and first name

emailstring

Key contact email.. If you provide this field, pleaase also provide first name and last name

Response

The customer was successfully created.

idstring required

Customer identifier.

namestring

<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">Customer name.</div>

ragStatus'green' | 'amber' | 'red'