---
title: "Create user"
method: POST
path: "/v1/users"
---

# Create user

`POST /v1/users`

Add a user to Transmit. A user_id is returned as part of the User in the response that can then be used to perform other operations, such as get, update and delete. An email or a phone_number are required.

## Request body

- ApiCreateUserInput
  - `email` string — Primary email address of the user
  - `phone_number` string — Primary phone number of the user, specified in E.164 format
  - `username` string — Username used to identify the user
  - `secondary_emails` string[] — Secondary email addresses to add to user's current emails
  - `secondary_phone_numbers` string[] — Secondary phone numbers to add to user's phone numbers, each specified in E.164 format
  - `birthday` string, date-time — User's birthday
  - `address` ApiCreateOrUpdateAddressInput
    - `country` string — Country
    - `state` string — State
    - `city` string — City
    - `street_address` string — Street address
    - `postal_code` string — Postal code
    - `type` 'home' | 'work' | 'other'
  - `name` ApiUserNameInput
    - `title` string — Title
    - `first_name` string — User's first name
    - `last_name` string — User's last name
    - `middle_name` string — User's middle name
  - `external_account_id` string — User identifier in an app, set by the app
  - `custom_app_data` object — Custom data object for app-related user info
  - `picture` string — The picture of user, specified as a URL
  - `language` string — The language of the user, as provided by the browser using the [Accept-Language](https://www.rfc-editor.org/rfc/rfc7231#section-5.3.5) header field
  - `custom_data` object — Custom data object for tenant user info
  - `external_user_id` string — A unique identifier in a tenant
  - `credentials` ApiUserPasswordInput
    - `password` string, required — The user's new password
    - `force_replace` boolean — When true the password is temporary and the user will be required to replace it upon successful login
  - `delegated_access` DelegatedAccessInput
    - `actor_id` string, required — The ID of the primary user that has permissions to act on behalf of this user
    - `permissions` string[], required — Names of permissions that are granted to the primary user on behalf of the dependent

## Response `201`

- object — The user has been successfully created.
  - `result` ApiUser, required
    - `email` string, email
    - `secondary_emails` ApiUserEmail[]
    - `phone_number` string — Primary phone number, specified in E.164 format
    - `secondary_phone_numbers` ApiUserPhone[]
    - `username` string — Username used to identify the user for password login (unless a primary email will be used instead). Defined only if a password was set for the user.
    - `user_id` string, required — User ID autogenerated upon user creation
    - `birthday` string, date-time — Birthday as YYYY-MM-DD
    - `address` ApiAddress
      - `country` string — Country
      - `state` string — State
      - `city` string — City
      - `street_address` string — Street address
      - `postal_code` string — Postal code
      - `type` 'home' | 'work' | 'other'
    - `name` ApiUserName
      - `title` string — Title
      - `first_name` string — User's first name
      - `last_name` string — User's last name
      - `middle_name` string — User's middle name
    - `status` 'ACTIVE' | 'INACTIVE' | 'DISABLED', required
    - `status_changed_at` string, date-time — Date status was last updated
    - `created_at` number, required — Date user was created in the tenant
    - `updated_at` number, required — Date user was last updated
    - `last_auth` string, date-time — Date user last authenticated
    - `external_account_id` string — User identifier in an app, set by the app
    - `app_name` string — Name of the app the user is associated with
    - `custom_app_data` object — Custom data object for app-related user info
    - `groupIds` string[] — List of group IDs the user is assigned to
    - `picture` string — The picture of user, specified as a URL
    - `language` string — The language of the user, as provided by the browser using the [Accept-Language](https://www.rfc-editor.org/rfc/rfc7231#section-5.3.5) header field
    - `custom_data` object — Custom data object for tenant user info
    - `external_user_id` string — A unique identifier in a tenant
    - `password_information` ApiPasswordInformation
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `expire_at` string, date-time — The date when the password will expire
      - `last_failure_at` string, date-time — The date when the last failure to authenticate occurred

## Other responses

- `400`
- `409`

---

[API](https://skmtc.net/transmitsecurity/apis/interactive-demo.md) · [All operations](https://skmtc.net/transmitsecurity/apis/interactive-demo/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/transmitsecurity/interactive-demo/versions/8ec1779aa02c/schema)