POST
/
User
curl --request POST \
  --url https://api-sandbox.payabli.com/api/User \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "email": "example@email.com",
  "phone": "5555555555",
  "name": "Sean Smith",
  "pwd": "<string>",
  "scope": [
    {
      "orgType": 0,
      "orgId": 123
    }
  ],
  "access": [
    {
      "roleLabel": "customers",
      "roleValue": true
    }
  ],
  "usrStatus": 1,
  "timeZone": -5,
  "language": "en",
  "mfaData": {
    "mfa": true,
    "mfaMode": 0
  },
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": null
}

Authorizations

​
requestToken
string
header
required

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

Body

UserData object to add
​
email
string | null

The user's email address.

Maximum length: 320
Example:

"example@email.com"

​
phone
string | null

The user's phone number.

Example:

"5555555555"

​
name
string | null
Example:

"Sean Smith"

​
pwd
string | null
​
scope
object[] | null
​
access
object[] | null
​
usrStatus
enum<integer> | null

The user's status:

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

1

​
timeZone
integer | null
default:0

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

Example:

-5

​
language
string | null

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

  • en
  • es
Example:

"en"

​
mfaData
object
​
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"
  }
}
Example:
{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

Response

200 - application/json
Success
​
isSuccess
boolean

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

Example:

true

​
responseText
string | null

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

Example:

"Success"

​
responseData
string | null

The response data.

Was this page helpful?