Update User Status

Endpoint to update an User status.

Log in to see full request history
Required scopes:
  • employee_write
Fingerprint order:
  • userId,status,token
Path Params
string
required

The User ID.

Body Params
string
required

The new User status.

Headers
string
required
Defaults to {{fingerprint}}

Advanced authentication: SHA512SUM of the Fingerprint order values.

string
required
Defaults to {{fingerprint_signature}}

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Responses

User.

Response body
object
string
required

The ID of the Contact assigned to the User. This information can be updated from the Add Contact and Update Contact endpoints.

string

The date and time when the User was created (sortable: yes).

string

The reference of the employee in an external system (sortable: yes).

string

The department of the User (sortable: no).

string

The Date of birth of the User.

string

The email address of the User (sortable: no).

array of strings

The list of Groups ID the User is member of (sortable: no).

groups
string

The User ID.

string

The job title of the User (sortable: yes).

string

The date and time when the User was last updated (sortable: yes).

string

The middlename of the User (sortable: no).

string

The mobile number of the User including the country code (sortable: no).

boolean

It determines whether the User has mobile access (sortable: no).

string

The mobile number country code (sortable: no).

string

The name of the User (sortable: yes).

string

The ID of the User it reports to.

array of objects

The list of UserRole of the User.

roles
object
string

The description of the UserRole.

string

The ID of the UserRole.

string

The name of the UserRole.

string

The scope of the UserRole.

object

The shipping Address of the User.

string

The category of the Address.

string

The type of the Address.

string

The name of the addressee.

string

The surname of the addressee.

string

The city of the Address.

string

The country of the Address.

string

The county of the Address.

string

The date and time when the Address was created.

boolean

True if the Address is the default shipping address.

string

The User ID, only if address_category is USER.

string

The date and time when the Address was last updated.

string

The actual name of the Address.

string

The Address street.

string

An optional other street.

string

The postal code of the Address.

string

The Address ID.

string

The status of the User (sortable: yes).

ACTIVE INACTIVE BLOCKED SUSPENDED PENDING ARCHIVED

string

The surname of the User (sortable: yes).

boolean

It determines whether the User is visible in the web console (sortable: yes).

boolean

It determines whether the User has web access (sortable: no).

400

Your request has missing arguments or is malformed.

404

One or more resource requested does not exist.

Language
Credentials
OAuth2
URL