APIPay Ops endpointsUser management

Update user

View as MarkdownOpen in Claude
Use this endpoint to modify the details of a specific user within an organization.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

userIdlongRequired
User Identifier

Request

This endpoint expects an object.
accesslist of objectsOptional
additionalDatamap from strings to optional maps from strings to anyOptional

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Max length for a value is 100 characters. Example usage:

1{
2  "additionalData": {
3    "key1": "value1",
4    "key2": "value2",
5    "key3": "value3"
6  }
7}
emailstringOptionalformat: "email"<=320 characters
The user's email address.
languagestringOptional

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

  • en
  • es
mfaDataobjectOptional
namestringOptional
phonestringOptional<=50 characters
The user's phone number.
pwdstringOptional
scopelist of objectsOptional
timeZoneintegerOptional

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

usrStatusintegerOptional

The user’s status:

  • Inactive: 0
  • Active: 1
  • Deleted: -99
  • Locked: 85

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean

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

responseDatamap from strings to any
The object containing the response data.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error