Skip to main content
POST
Add a New User

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a new end user on the platform.

email
string<email>
required

User's email address. Must be unique within the platform and RFC 5321 compliant.

Maximum string length: 254
Example:

"john.doe@example.com"

first_name
string | null

User's given name. Required for an individual (is_business_user false); ignored for a business.

Maximum string length: 100
Example:

"John"

last_name
string | null

User's family name. Required for an individual; ignored for a business.

Maximum string length: 100
Example:

"Doe"

name
string | null

Deprecated combined full name for an individual. Send first_name and last_name instead; when only name is provided it is split into first/last automatically and must carry both.

Maximum string length: 100
Example:

"John Doe"

is_business_user
boolean
default:false

Set to true when this user is a business/organization rather than an individual. When true, send business_name and omit first/last name. This is fixed at creation and cannot be changed later.

Example:

false

business_name
string | null

Organization name. Required when is_business_user is true; leave empty for an individual.

Maximum string length: 100
Example:

"Acme Corporation"

Response

The newly created user.

status_code
integer
required

HTTP status code for the response.

data
PlatformUserRead · object
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.