Skip to main content
PUT
Update external user profile

Authorizations

X-API-KEY
string
header
required

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

Path Parameters

externalId
string
required

The external ID of the user.

Body

application/json
username
string

The new username for the user.

Example:

"dfs"

displayName
string

The new display name for the user.

Example:

"strsdfing"

image
string | null

URL to the user's profile image.

Example:

"strsdfsding"

coverImage
string | null

URL to the user's cover image.

Example:

"stsdring"

Response

External user profile updated successfully

success
boolean

Indicates if the request was successful.

Example:

true

message
string

A message describing the result of the operation.

Example:

"External user profile updated successfully"

data
object
meta
object