POST /users
Creates a user.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
availableCurrencies[] |
Array | No |
Array of reporting currencies that are enabled for the merchant. |
createdTime |
String | No |
Date and time when the batch was created. |
roleIds[] |
Array | No |
Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin. |
reportingCurrency |
String | No |
User's currency code in ISO 4217 format. This value is used for reports. |
status |
String | No |
Status of the user's account. Valid values:
|
allowedIps[] |
Array | No |
List of IP addresses that are permitted access.
Private subnets are prohibited.
To remove restrictions, set this value to |
permissions[] |
Array | No |
Permissions that the user has within organizations.
Use the wildcard character |
loginTime |
String | No |
Date and time when the user last logged in. |
computedPermissions |
Object | No |
All user permissions and roles. Use these permissions to emulate the user. |
id |
String | No |
ID of the user. |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
email |
String | Yes |
Email address of the user. |
updatedTime |
String | No |
Date and time when the batch was last updated. |
lastName |
String | Yes |
User's last name. |
businessPhone |
String | No |
User's business phone number. |
preferences |
Object | No |
User preferences, such as: timezone, language, and more. This is an object with custom properties. |
mobilePhone |
String | No |
User's mobile phone number. |
firstName |
String | Yes |
User's first name. |
country |
String | No |
User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.