Creates a new user account in the dialogportal™ database with fields specified in a contract between the calling application and dialogportal™. dialogportal™ automatically assigns a unique key for the new account and optionally a key with an external type.
| Endpoint ID: | 1001 | |||||||
| Method | POST | |||||||
| URL: | /user/{contract-id} | |||||||
| contract-id | Identifies the set of contract fields passed in the request body. If omitted, the default contract for the particular app is used. | |||||||
| Request body: | JSON data with properties corresponding to the fields in the specified contract Example 1 - Contract specifies full name, email and password: {
"name": "John Doe",
"email": "mailbox@mailserver.com",
"password": "password"
}
| |||||||
| JSON data with key(s) for the newly created account and data for the account. The result will always hold the dialogportal™ master key and if the app making the request is configured to use a specific external key, this key is also included in the response. Example 1 – App setting specifies no specific key: {
"dpKey": 123456
"name": "John Doe",
"email": "mailbox@mailserver.com",
}
Example 2 – App setting specifies external key type: {
"dpKey": 123456,
"extKeyType": 12,
"extKey": "key"
"name": "John Doe",
"email": "mailbox@mailserver.com",
}
| |||||||
| Status codes: | 201 | Account was created with success | ||||||
| 303 | Account already exists | |||||||
| 400 | Request is valid but data validation failed In case SMS verification is enabled, the following sub codes may be returned:
| |||||||