PUT
/
User
/
{userId}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

userId
integer
required

User Identifier

Body

access
object[] | null
additionalData
object

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"
  }
}
email
string | null

The user's email address.

language
string | null

The user's locale for PartnerHub and PayHub localization. Supported values:

  • en
  • es
mfaData
object
name
string | null
phone
string | null

The user's phone number.

pwd
string | null
scope
object[] | null
timeZone
integer | null
default:
0

Timezone, in UTC offset. For example, -5 is Eastern time.

usrStatus
enum<integer> | null

The user's status:

  • Inactive: 0
  • Active: 1
  • Deleted: -99
  • Locked: 85
Available options:
0,
1,
-99,
85

Response

200 - application/json
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseData
object | null

The object containing the response data.

responseText
string | null

Response text for operation: 'Success' or 'Declined'.