Skip to main content
POST
Create a user

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Body

Creates a user.

Fields of a user that you set when creating or updating it.

reference_id
string

Your own reference, for example an ID from your system.

Example:

"USR1234567890"

Response

Success: the user resource.

A user of your service.

id
string
required

Flatpeak User ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"usr_65e421d1daa4a24082b4f590"

object
enum<string>
default:user
required

Object type.

Available options:
user
Example:

"user"

live_mode
boolean
required

true for live data, false for test data.

account_id
string
required

Flatpeak Account ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"acc_65e421bed29d88d9012e0662"

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2021-05-05T05:37:27Z"

reference_id
string

Your own reference, for example an ID from your system.

Example:

"USR1234567890"

location_ids
string[]

Flatpeak IDs of the user's locations.