The POST User API allows you to create a new user.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/user?format=xml/json
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/user | Model Description/Schema & Parameters |
Parameters
The POST verb on the User API allows you to create a new user on our platform. The required and optional parameters for a POST call to the User API are outlined below:
| Name | Type | Description | Required |
|---|---|---|---|
| Type | String | Standard: Best for light to medium usage. Can capture up to 1,500 Form entries per month. No Tasks or Docs access. Premium: Unlocks all platform features, including Task and Docs, with unlimited monthly Form entries. Lite: Legacy option, discontinued. Full: Legacy option for grandfathered plans only. | |
| FirstName | String | The firstname of the user being added. | ✓ |
| LastName | String | The lastname of the user being added. | ✓ |
| String | The email address of the user to be added. | ✓ | |
| Password | String | The password of the user to be added. | |
| ExternalId | String | The external ID of the user to be added. | |
| TimeZone | String | The name of Timezone, e.g., CAT, EST, etc… | |
| Country | String | The name of the country of the user being added. | |
| WebsiteRole | String | [‘ReadOnly’, ‘User’, ‘Admin’, ‘EnterpriseAdmin’, ‘VendorAdmin’, ‘SuperAdmin’] | |
| Folders | Array | A list of folders that the user is to be added to. | |
| Groups | Array | A list of groups the user is to be added to. | |
| DoNotEmail | Boolean | A flag to email the new user or not. | |
| ColorCode | String | Assign this user a unique HTML color code. This will be used in various parts of the platform where users are identified by their color. | |
| Metadata | Array | Additional information about this user specified as key/value pairs. | |
| UseNames | Boolean | Use Names instead of GUID identifier for any Groups and Folders values | |
| UseExternalIds | Boolean | Use External ID instead of GUID identifier for any Groups and Folders values. | |
| LoginID | String | The username or other such non-email identifier as defined in your external identity provider when Email-less Login is enabled. By default is user email. | |
| CompanyId | Integer | Your unique Company Id found on the Organisation Setup page of the secure website. | ✓ |
| IntegrationKey | String | Your unique Integration Key found on the Organisation Setup page of the secure website. | ✓ |
Example
Given that the API is REST-based, you can access the API directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.
Request URL
https://eforms.mobileform.net/api/v2/userBelow is an unpopulated code block of what a typical POST request JSON body to the User API might look like.
Request Body
{
"Type": "",
"FirstName": "",
"LastName": "",
"Email": "",
"Password": "",
"ExternalId": "",
"TimeZone": "",
"Country": "",
"WebsiteRole": "",
"Folders": [
""
],
"Groups": [
""
],
"DoNotEmail": false,
"ColorCode": "",
"Metadata": [
{
"Key": "",
"Val": "",
"Index": 0
}
],
"UseNames": false,
"UseExternalIds": false,
"CompanyId": 0,
"IntegrationKey": ""
}