Modify User
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
User Identifier
Body
The user's email address.
320
"example@email.com"
The user's phone number.
"5555555555"
"Sean Smith"
The user's status:
- Inactive: 0
- Active: 1
- Deleted: -99
- Locked: 85
0
, 1
, -99
, 85
1
Timezone, in UTC offset. For example, -5 is Eastern time.
-5
The user's locale for PartnerHub and PayHub localization. Supported values:
en
es
"en"
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
The object containing the response data.
Was this page helpful?