POST api/users/activation-link?customerId={customerId}&defaultPortalId={defaultPortalId}
Register one user profile per turn.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerId |
The ID of the customer associated with that user. |
integer |
Required |
defaultPortalId |
Optional. The ID of the default portal associated with that user. |
integer |
None. |
Body Parameters
An user to be registered.
Name | Description | Type | Additional information |
---|---|---|---|
FirstName |
First Name |
string |
Required Max length: 255 |
Surname |
Surname |
string |
Required Max length: 255 |
Email address (will be used as login) |
string |
Required Max length: 512 |
|
SalaryNumber |
Salary Number (if known) |
string |
Max length: 512 |
Gender |
Gender |
UserProfileGenderEnum |
None. |
Request Formats
application/json, text/json
Sample:
{ "firstName": "sample string 1", "surname": "sample string 2", "email": "sample string 3", "salaryNumber": "sample string 4", "gender": 0 }
Response Information
Unique identificator that can be used for user activation.
Name | Description | Type | Additional information |
---|---|---|---|
ActivationGuid | globally unique identifier |
None. |
|
ErrorDetails | Collection of ErrorDetails |
None. |
Response Formats
application/json, text/json
Sample:
{ "activationGuid": "e1c6eb86-4566-4c6d-a80e-3d4487fcada1", "errorDetails": [ { "message": "sample string 1" }, { "message": "sample string 1" } ] }