CreateAccountUserRequest

Request schema for creating a user in an account

add_providerboolean

Whether to create a staff member (provider) for this user. If a provider with the same email already exists, it will be affiliated with this user instead of creating a new one.

Default value: false

display_namestring

The display name for the staff member. Only used when add_provider is true. Defaults to 'FirstName LastName' if not provided.

emailstring<email>required

The user's email address.

first_namestringrequired

The user's first name.

last_namestringrequired

The user's last name.

notifyboolean

Whether to send an email notification to the user. If they don't already have an account, they will receive an email with instructions to set their password when this property is true.

Default value: false

passiveboolean

Whether this user is passive. Passive users do not receive direct email notifications (e.g., OAuth reconnection notices). Use this for platform/headless scenarios where the platform handles user communication.

Default value: false

role_idsstring[]

List of role IDs to assign to the user.

Possible values: Value must match regular expression ^role_\w{12}$

time_zonestring

The user's time zone.

CreateAccountUserRequest

{
  "add_provider": false,
  "display_name": "Dr. John Doe",
  "email": "john.doe@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "notify": false,
  "passive": false,
  "role_ids": [
    "role_123456789012"
  ],
  "time_zone": "America/Chicago"
}