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 where the user will be created.
Query Parameters
If true, sends an activation email to the user. Defaults to true.
Body Parameters
Primary email address for the user. Must be unique across the environment.
Your application’s unique identifier for this user.
User’s personal information including name and contact details. User’s first name. Maximum 255 characters.
User’s last name. Maximum 255 characters.
Full name in display format.
user_profile.phone_number
Phone number in E.164 international format. User’s localization preference in BCP-47 format. URL to the user’s profile picture.
user_profile.custom_attributes
Custom attributes for extended user profile data.
Membership details including roles and metadata. List of roles to assign to the user. Custom key-value pairs for storing additional membership context. {
"department" : "engineering" ,
"location" : "nyc-office"
}
Custom key-value pairs for storing additional user context. {
"department" : "engineering" ,
"location" : "nyc-office"
}
Response
The created user object, including system-generated identifiers and timestamps. Unique system-generated identifier for the user Primary email address for the user
Your application’s unique identifier
User’s personal information
List of organization memberships
Timestamp when the user account was created (ISO 8601)
Timestamp of the last modification (ISO 8601)
Timestamp of the user’s most recent successful authentication (ISO 8601)
Examples
Error Responses
User created successfully