User
Modify User
PUT
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
User Identifier
Body
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
The user's email address.
The user's locale for PartnerHub and PayHub localization. Supported values:
en
es
The user's phone number.
Timezone, in UTC offset. For example, -5 is Eastern time.
The user's status:
- Inactive: 0
- Active: 1
- Deleted: -99
- Locked: 85
Available options:
0
, 1
, -99
, 85
Response
200 - application/json
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
The object containing the response data.
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?