Create user

Create a new user account and add them to an organization

POST /api/v1/organizations//users

Creates a new user account and immediately adds them to the specified organization. Use this endpoint when you want to create a user and grant them access to an organization in a single operation.

Request

Path Parameters

organization_id · string · required

Organization ID where the user will be created.

org_123

Query Parameters

send_invitation_email · boolean

If true, sends an activation email to the user. Defaults to true.

true

Body Parameters

email · string · required

Primary email address for the user. Must be unique across the environment.

[e-mail]

external_id · string

Your application’s unique identifier for this user.

ext_12345a67b89c

user_profile · object

User’s personal information including name and contact details.

Show user_profile fields

user_profile.given_name · string

User’s first name. Maximum 255 characters.

user_profile.family_name · string

User’s last name. Maximum 255 characters.

user_profile.name · string

Full name in display format.

user_profile.phone_number · string

Phone number in E.164 international format.

[phone]

user_profile.locale · string

User’s localization preference in BCP-47 format.

en-US

user_profile.picture · string

URL to the user’s profile picture.

user_profile.custom_attributes · object

Custom attributes for extended user profile data.

membership · object

Membership details including roles and metadata.

Show membership fields

membership.roles · array

List of roles to assign to the user.

[{"name": "member"}]

membership.metadata · object

Custom key-value pairs for storing additional membership context.

{
  "department": "engineering",
  "location": "nyc-office"
}

metadata · object

Custom key-value pairs for storing additional user context.

{
  "department": "engineering",
  "location": "nyc-office"
}

Response

user · object

The created user object, including system-generated identifiers and timestamps.

Show user object

id · string

Unique system-generated identifier for the user

usr_1234abcd5678efgh

email · string

Primary email address for the user

external_id · string

Your application’s unique identifier

user_profile · object

User’s personal information

memberships · array

List of organization memberships

metadata · object

Custom key-value pairs

create_time · string

Timestamp when the user account was created (ISO 8601)

update_time · string

Timestamp of the last modification (ISO 8601)

last_login_time · string

Timestamp of the user’s most recent successful authentication (ISO 8601)

Examples

Error Responses

201 · success

User created successfully