Payabli Docs

Use this endpoint to add a new user to an organization.

Authentication

requestTokenstring

API Key authentication via header

Request

This endpoint expects an object.

accesslist of objectsOptional

additionalDatamap from strings to 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 language code.

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.

responseDatastring

The response data.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error

API Key authentication via header

This endpoint expects an object.

1 {
2   "additionalData": {
3     "key1": "value1",
4     "key2": "value2",
5     "key3": "value3"
6   }
7 }

The user's email address.

The user's phone number.

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

The user’s status:

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

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

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

$	curl -X POST https://api-sandbox.payabli.com/api/User \
>	-H "requestToken: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

$	curl -X POST https://api-sandbox.payabli.com/api/User \
>	-H "requestToken: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

Create user

Create user

Authentication

Request

Response

Errors

Authentication

Request

Response

Errors

1	{
2	"additionalData": {
3	"key1": "value1",
4	"key2": "value2",
5	"key3": "value3"
6	}
7	}