User

Modify User in an Organization

Use this endpoint to modify the details of a specific user within an organization.

put/User/{userId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/User/{userId}
  • Auth: HTTP bearer

Path parameters

userIdinteger required

User Identifier

Request body

additionalDataAdditionalDataMap

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.

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
emailstring email

Email address.

languagestring

The language code.

namestring
phonestring

Phone number.

pwdstring
timeZoneinteger

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

usrStatusinteger

The user's status:

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

Response

Success

isSuccessboolean

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

responseDataResponsedata

The object containing the response data.

responseTextstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.