POST Api/v{apiVersion}/Account?operatorID={operatorID}
Creates a new account
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| operatorID | globally unique identifier |
Required |
|
| apiVersion | string |
None. |
Body Parameters
AccountValues| Name | Description | Type | Additional information |
|---|---|---|---|
| FirstName | string |
None. |
|
| MiddleName | string |
None. |
|
| LastName | string |
None. |
|
| EmailAddress | string |
None. |
|
| PhoneNumber | string |
None. |
|
| Password | string |
None. |
|
| ConfirmedPassword | string |
None. |
|
| CustomColor | string |
None. |
|
| IsMailSubscribed | boolean |
None. |
|
| ApiKey | globally unique identifier |
None. |
|
| Notes | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"FirstName": "sample string 1",
"MiddleName": "sample string 2",
"LastName": "sample string 3",
"EmailAddress": "sample string 4",
"PhoneNumber": "sample string 5",
"Password": "sample string 6",
"ConfirmedPassword": "sample string 7",
"CustomColor": "sample string 8",
"IsMailSubscribed": true,
"ApiKey": "dc49107d-62df-4817-8e14-fc57b29c1c57",
"Notes": "sample string 11"
}
application/xml, text/xml
Sample:
<AccountValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels"> <ApiKey>dc49107d-62df-4817-8e14-fc57b29c1c57</ApiKey> <ConfirmedPassword>sample string 7</ConfirmedPassword> <CustomColor>sample string 8</CustomColor> <EmailAddress>sample string 4</EmailAddress> <FirstName>sample string 1</FirstName> <IsMailSubscribed>true</IsMailSubscribed> <LastName>sample string 3</LastName> <MiddleName>sample string 2</MiddleName> <Notes>sample string 11</Notes> <Password>sample string 6</Password> <PhoneNumber>sample string 5</PhoneNumber> </AccountValues>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FirstName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MiddleName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="LastName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="EmailAddress" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PhoneNumber" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Password" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ConfirmedPassword" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomColor" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsMailSubscribed" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ApiKey" dc49107d-62df-4817-8e14-fc57b29c1c57 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Notes" sample string 11 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
AccountDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID | globally unique identifier |
None. |
|
| Type | UserType |
None. |
|
| FirstName | string |
None. |
|
| MiddleName | string |
None. |
|
| LastName | string |
None. |
|
| FullName | string |
None. |
|
| LinkedEntityName | string |
None. |
|
| LinkedEntityID | string |
None. |
|
| EmailAddress | string |
None. |
|
| PhoneNumber | string |
None. |
|
| Roles | Collection of string |
None. |
|
| LastLoginDate | date |
None. |
|
| CustomBackgroundImage | FilePreview |
None. |
|
| CustomColor | string |
None. |
|
| CustomWelcomeText | string |
None. |
|
| IsMailSubscribed | boolean |
None. |
|
| PasswordModifiedAt | date |
None. |
|
| PasswordModifiedBy | string |
None. |
|
| ApiKey | globally unique identifier |
None. |
|
| Notes | string |
None. |
|
| CreatedAt | date |
None. |
|
| CreatedBy | string |
None. |
|
| ModifiedAt | date |
None. |
|
| ModifiedBy | string |
None. |
Response Formats
application/json
Sample:
{
"UserID": "322b02a1-55ad-4000-a14b-dfed72cd7e82",
"Type": "Operator",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"FullName": "sample string 5",
"LinkedEntityName": "sample string 6",
"LinkedEntityID": "sample string 7",
"EmailAddress": "sample string 8",
"PhoneNumber": "sample string 9",
"Roles": [
"sample string 1",
"sample string 2"
],
"LastLoginDate": "2026-01-15T14:12:32.7190512Z",
"CustomBackgroundImage": {
"FileID": "6b2616a3-949d-479a-b1e0-b23354606592",
"LinkedEntityID": "4b2ce8ed-2b41-4566-9d12-6c62e8377800",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "https://hier.ralphkamphuis.nl/api/v1/files/6b2616a3-949d-479a-b1e0-b23354606592/blob?0804c920-b420-43a6-a6e4-0cee5f2ca6e3"
},
"CustomColor": "sample string 10",
"CustomWelcomeText": "sample string 11",
"IsMailSubscribed": true,
"PasswordModifiedAt": "2026-01-15T14:12:32.7190512Z",
"PasswordModifiedBy": "sample string 14",
"ApiKey": "6fedded9-bf59-47f0-9fc0-7e1db2d85319",
"Notes": "sample string 16",
"CreatedAt": "2026-01-15T14:12:32.7190512Z",
"CreatedBy": "sample string 18",
"ModifiedAt": "2026-01-15T14:12:32.7190512Z",
"ModifiedBy": "sample string 20"
}
text/json
Sample:
{
"UserID": "322b02a1-55ad-4000-a14b-dfed72cd7e82",
"Type": "Operator",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"FullName": "sample string 5",
"LinkedEntityName": "sample string 6",
"LinkedEntityID": "sample string 7",
"EmailAddress": "sample string 8",
"PhoneNumber": "sample string 9",
"Roles": [
"sample string 1",
"sample string 2"
],
"LastLoginDate": "2026-01-15T14:12:32.7190512Z",
"CustomBackgroundImage": {
"FileID": "6b2616a3-949d-479a-b1e0-b23354606592",
"LinkedEntityID": "4b2ce8ed-2b41-4566-9d12-6c62e8377800",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "https://hier.ralphkamphuis.nl/api/v1/files/6b2616a3-949d-479a-b1e0-b23354606592/blob?0bdc5fad-0222-4690-bf04-13e1521b7560"
},
"CustomColor": "sample string 10",
"CustomWelcomeText": "sample string 11",
"IsMailSubscribed": true,
"PasswordModifiedAt": "2026-01-15T14:12:32.7190512Z",
"PasswordModifiedBy": "sample string 14",
"ApiKey": "6fedded9-bf59-47f0-9fc0-7e1db2d85319",
"Notes": "sample string 16",
"CreatedAt": "2026-01-15T14:12:32.7190512Z",
"CreatedBy": "sample string 18",
"ModifiedAt": "2026-01-15T14:12:32.7190512Z",
"ModifiedBy": "sample string 20"
}
application/xml, text/xml
Sample:
<AccountDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
<ApiKey>6fedded9-bf59-47f0-9fc0-7e1db2d85319</ApiKey>
<CreatedAt>2026-01-15T15:12:32.7190512+01:00</CreatedAt>
<CreatedBy>sample string 18</CreatedBy>
<CustomBackgroundImage>
<FileID>6b2616a3-949d-479a-b1e0-b23354606592</FileID>
<FileName>sample string 4</FileName>
<LinkedEntityID>4b2ce8ed-2b41-4566-9d12-6c62e8377800</LinkedEntityID>
<LinkedPropertyName>sample string 3</LinkedPropertyName>
</CustomBackgroundImage>
<CustomColor>sample string 10</CustomColor>
<CustomWelcomeText>sample string 11</CustomWelcomeText>
<EmailAddress>sample string 8</EmailAddress>
<FirstName>sample string 2</FirstName>
<FullName>sample string 5</FullName>
<IsMailSubscribed>true</IsMailSubscribed>
<LastLoginDate>2026-01-15T15:12:32.7190512+01:00</LastLoginDate>
<LastName>sample string 4</LastName>
<LinkedEntityID>sample string 7</LinkedEntityID>
<LinkedEntityName>sample string 6</LinkedEntityName>
<MiddleName>sample string 3</MiddleName>
<ModifiedAt>2026-01-15T15:12:32.7190512+01:00</ModifiedAt>
<ModifiedBy>sample string 20</ModifiedBy>
<Notes>sample string 16</Notes>
<PasswordModifiedAt>2026-01-15T15:12:32.7190512+01:00</PasswordModifiedAt>
<PasswordModifiedBy>sample string 14</PasswordModifiedBy>
<PhoneNumber>sample string 9</PhoneNumber>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Roles>
<Type>Operator</Type>
<UserID>322b02a1-55ad-4000-a14b-dfed72cd7e82</UserID>
</AccountDetails>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="UserID" 322b02a1-55ad-4000-a14b-dfed72cd7e82 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Type" Operator --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FirstName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MiddleName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="LastName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FullName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="LinkedEntityName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="LinkedEntityID" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="EmailAddress" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PhoneNumber" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Roles[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Roles[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="LastLoginDate" 2026-01-15T15:12:32.7190512+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomBackgroundImage.FileID" 6b2616a3-949d-479a-b1e0-b23354606592 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomBackgroundImage.LinkedEntityID" 4b2ce8ed-2b41-4566-9d12-6c62e8377800 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomBackgroundImage.LinkedPropertyName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomBackgroundImage.FileName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomBackgroundImage.ContentType" application/ --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomBackgroundImage.BlobUrl" https://hier.ralphkamphuis.nl/api/v1/files/6b2616a3-949d-479a-b1e0-b23354606592/blob?30c22602-8b60-4513-b7da-e8e6a5e32ccb --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomColor" sample string 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomWelcomeText" sample string 11 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsMailSubscribed" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PasswordModifiedAt" 2026-01-15T15:12:32.7190512+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PasswordModifiedBy" sample string 14 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ApiKey" 6fedded9-bf59-47f0-9fc0-7e1db2d85319 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Notes" sample string 16 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedAt" 2026-01-15T15:12:32.7190512+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedBy" sample string 18 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedAt" 2026-01-15T15:12:32.7190512+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedBy" sample string 20 --MultipartDataMediaFormatterBoundary1q2w3e--