API Reference

Update a single user

patch
https://api.mobilize.io/v1.1/users/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

Updating of a field from type file, is not yet supported.
Please contact your customer success manager with any questions or comments

Path Params
required

One of the following:

  • The integer uniquely associated with a user
  • |
    A pair consisting of an External ID Namespace and an External ID, separated by a : character.
    The Namespace component may not contain the characters : or /.
Body Params

The attributes to change. At least one of fields, external_ids or membership_tier
must be supplied. Anything omitted is left as it is, including the user's existing
external identifiers.

external_ids
array of objects

The user's complete set of namespaced external identifiers. Any identifier the user
carries and this array omits is removed, and an empty array removes all of them. An
identifier already mapped to another user in the organization returns 422.

external_ids
fields
object

Profile fields for the user.
Each property must correspond to a defined or special field.
If the name field is specified alongside first_name and/or last_name, name will take precedence.

membership_tier
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*

Updated 3 months ago

Did this page help you?