POST
/
users

Body

application/json

The data with which a user is created.

external_id
string
required

A string that uniquely identifies the user within your project. Ensure that this is the ID that you use to identify the user in your system e.g. database ID, Firebase Auth ID etc. Failing to do so may cause unexpected bugs and errors in your application.

first_name
string | null

The first name of the user.

last_name
string | null

The last name of the user.

live_mode
boolean | null

Whether the user exists in live mode. This will be false if the user is a test user.

Response

200 - application/json
<p>Represents a user of your project.</p>
id
string
required

The unique identifier of the user

object
enum<string>
required

The type of the User object

Available options:
user
created_at
integer
required

The time at which the object was created, measured in milliseconds since the Unix epoch

external_id
string
required

A string that uniquely identifies the user within your project. Ensure that this is the ID that you use to identify the user in your system e.g. database ID, Firebase Auth ID etc. Failing to do so may cause unexpected bugs and errors in your application.

first_name
string
required

The first name of the user.

last_name
string
required

The last name of the user.

live_mode
boolean
required

Whether the user exists in live mode. This will be false if the user is a test user.

updated_at
integer
required

The time at which the object was last updated, measured in milliseconds since the Unix epoch