Updating a User

You can update users via the Users API.

PATCH https://driftapi.com/users/update?userId={userId}

ex: PATCH https://driftapi.com/users/update?userId=21965

Acceptable Fields for Patch Body

attribute

type

description

name

string

The name of the user

alias

string

The alias of the user

email

string (valid email)

The email of the user

phone

string (valid phone)
XXX-XXX-XXXX

The phone number of the user

locale

string

The locale of the user

avatarUrl

string

The url pointing to the avatar image of the user

availability

string

one of {AVAILABLE, OFFLINE}

Updating a User

https://driftapi.com/users/update?userId={userId}
body:
{
    "attribute_name": new_attribute_val, ...
}
  

-------------------------------------------------
response-success:
{
    data: User (updated)
}

📘

An example use case

The User API can be used to update the availability of a particular user (or users) programmatically, i.e. via an external system to control users' availabilities.

🚧

Updating user roles

User roles cannot be updated via API at this time.


Did this page help you?