API referencePay Ops endpointsUser management

Create user

Headers

requestTokenstringRequired

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](/developer-guides/entities-custom-identifiers), pass those in this object. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
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
isSuccessboolean or null

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

responseDatastring or null
The response data.
responseTextstring or null

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

Errors