Skip to main content

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.
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.
membership
object
Membership details including roles and metadata.
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.

Examples

    Error Responses

    201
    success
    User created successfully

    Build docs developers (and LLMs) love