PUT
/
users

Authorizations

api-key
string
headerrequired

Your Melodi API key

Body

application/json

Request object for creating or updating an external user

externalId
string
required

External identifier for the user

email
string

User's email address

name
string

User's name

username
string

User's username

segments
object

Key-value pairs of segment information. Will be transformed to empty object if null or undefined.

Response

200 - application/json

Represents an external user. Note: The combination of organizationId and externalId must be unique.

id
number
required

Unique identifier for the user

organizationId
number
required

ID of the organization this user belongs to

externalId
string
required

External identifier for the user

segments
object[]
required
createdAt
string
required
updatedAt
string
required
name
string | null

User's name

email
string | null

User's email address

username
string | null

User's username

Was this page helpful?

Create FeedbackGet Threads