Skip to main content
POST
Register a new user

Authorizations

X-API-KEY
string
header
required

API key for authentication. You can generate this from the 16TMS console.

Body

application/json
externalId
string
required

The unique identifier for the user from your external system.

Example:

"user_123"

displayName
string
required

The display name for the user.

Example:

"John Doe"

username
string

The username for the user.

Example:

"johndoe"

email
string<email>

The email address of the user.

Example:

"user@example.com"

phoneNumber
string

The phone number of the user.

Example:

"+1234567890"

countryCode
string

The country code for the phone number.

Example:

"+1"

image
string<uri>

URL to the user's profile image.

Example:

"https://example.com/images/profile.jpg"

coverImage
string<uri>

URL to the user's cover image.

Example:

"https://example.com/images/cover.jpg"

Response

User registered successfully

success
boolean

Indicates if the request was successful.

Example:

true

message
string

A message describing the result of the operation.

Example:

"User registered successfully"

data
object
meta
object