Add User to Organization
POST
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Body
UserData object to add
The user's email address.
Maximum length:
320
Example:
"example@email.com"
The user's phone number.
Example:
"5555555555"
Example:
"Sean Smith"
The user's status:
- Inactive: 0
- Active: 1
- Deleted: -99
- Locked: 85
Available options:
0
, 1
, -99
, 85
Example:
1
Timezone, in UTC offset. For example, -5 is Eastern time.
Example:
-5
The user's locale for PartnerHub and PayHub localization. Supported values:
en
es
Example:
"en"
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
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
Example:
true
Response text for operation: 'Success' or 'Declined'.
Example:
"Success"
The response data.
Was this page helpful?