Sign in

v1

latestOpenAPI 3.0.32026-08-0631918.6 KB

Create user

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.

post/v1/users

Request body

emailstring

Primary email address of the user

phone_numberstring

Primary phone number of the user, specified in E.164 format

usernamestring

Username used to identify the user

secondary_emailsstring[]

Secondary email addresses to add to user's current emails

secondary_phone_numbersstring[]

Secondary phone numbers to add to user's phone numbers, each specified in E.164 format

birthdaystring date-time

User's birthday

external_account_idstring

User identifier in an app, set by the app

custom_app_dataobject

Custom data object for app-related user info

picturestring

The picture of user, specified as a URL

languagestring

The language of the user, as provided by the browser using the Accept-Language header field

custom_dataobject

Custom data object for tenant user info

external_user_idstring

A unique identifier in a tenant

Example request

{
  "username": "<ADD USERNAME HERE>",
  "credentials": {
    "password": "<ADD PASSWORD HERE>",
    "force_replace": false
  }
}

Response

All 3 operations