POST user/register

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Username	string	Required
Password	string	Required
ConfirmPassword	string	None.
Title	string	Required
FirstName	string	Required
Surname	string	Required
IDNumber	string	Required
Cell	string	Required
EmployeeNo	string	Required
Email	string	Required
DeviceID	string	Required
AuthenticationMethod	integer	Required
TenantId	integer	Required
UserType	integer	Required
UserPic	string	None.
Active	boolean	Required
Roles	Collection of integer	None.
ReportRoles	Collection of integer	None.
Divisions	Collection of integer	None.
AppointmentBookingMethod	integer	None.
ManagerUserID	integer	None.
SuiteUsername	string	None.
SuiteUserNo	string	None.
isLsnUser	boolean	None.
VoipEnabled	boolean	None.
VoipUsername	string	None.
VoipPassword	string	None.
VoipExtension	string	None.
KeepCustomPassword	boolean	None.
UserCode	string	None.
TimeoutLimit	integer	None.
BlockEmailSending	boolean	None.
TrustedUser	boolean	None.
TemplateParentId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "ConfirmPassword": "sample string 3",
  "Title": "sample string 4",
  "FirstName": "sample string 5",
  "Surname": "sample string 6",
  "IDNumber": "sample string 7",
  "Cell": "sample string 8",
  "EmployeeNo": "sample string 9",
  "Email": "sample string 10",
  "DeviceID": "sample string 11",
  "AuthenticationMethod": 12,
  "TenantId": 13,
  "UserType": 14,
  "UserPic": "sample string 15",
  "Active": true,
  "Roles": [
    1,
    2
  ],
  "ReportRoles": [
    1,
    2
  ],
  "Divisions": [
    1,
    2
  ],
  "AppointmentBookingMethod": 17,
  "ManagerUserID": 1,
  "SuiteUsername": "sample string 18",
  "SuiteUserNo": "sample string 19",
  "isLsnUser": true,
  "VoipEnabled": true,
  "VoipUsername": "sample string 20",
  "VoipPassword": "sample string 21",
  "VoipExtension": "sample string 22",
  "KeepCustomPassword": true,
  "UserCode": "sample string 24",
  "TimeoutLimit": 1,
  "BlockEmailSending": true,
  "TrustedUser": true,
  "TemplateParentId": 1
}

text/html

Sample:

{"Username":"sample string 1","Password":"sample string 2","ConfirmPassword":"sample string 3","Title":"sample string 4","FirstName":"sample string 5","Surname":"sample string 6","IDNumber":"sample string 7","Cell":"sample string 8","EmployeeNo":"sample string 9","Email":"sample string 10","DeviceID":"sample string 11","AuthenticationMethod":12,"TenantId":13,"UserType":14,"UserPic":"sample string 15","Active":true,"Roles":[1,2],"ReportRoles":[1,2],"Divisions":[1,2],"AppointmentBookingMethod":17,"ManagerUserID":1,"SuiteUsername":"sample string 18","SuiteUserNo":"sample string 19","isLsnUser":true,"VoipEnabled":true,"VoipUsername":"sample string 20","VoipPassword":"sample string 21","VoipExtension":"sample string 22","KeepCustomPassword":true,"UserCode":"sample string 24","TimeoutLimit":1,"BlockEmailSending":true,"TrustedUser":true,"TemplateParentId":1}

application/xml, text/xml

Sample:

<RegistrationDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities">
  <Active>true</Active>
  <AppointmentBookingMethod>17</AppointmentBookingMethod>
  <AuthenticationMethod>12</AuthenticationMethod>
  <BlockEmailSending>true</BlockEmailSending>
  <Cell>sample string 8</Cell>
  <ConfirmPassword>sample string 3</ConfirmPassword>
  <DeviceID>sample string 11</DeviceID>
  <Divisions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Divisions>
  <Email>sample string 10</Email>
  <EmployeeNo>sample string 9</EmployeeNo>
  <FirstName>sample string 5</FirstName>
  <IDNumber>sample string 7</IDNumber>
  <KeepCustomPassword>true</KeepCustomPassword>
  <ManagerUserID>1</ManagerUserID>
  <Password>sample string 2</Password>
  <ReportRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ReportRoles>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Roles>
  <SuiteUserNo>sample string 19</SuiteUserNo>
  <SuiteUsername>sample string 18</SuiteUsername>
  <Surname>sample string 6</Surname>
  <TemplateParentId>1</TemplateParentId>
  <TenantId>13</TenantId>
  <TimeoutLimit>1</TimeoutLimit>
  <Title>sample string 4</Title>
  <TrustedUser>true</TrustedUser>
  <UserCode>sample string 24</UserCode>
  <UserPic>sample string 15</UserPic>
  <UserType>14</UserType>
  <Username>sample string 1</Username>
  <VoipEnabled>true</VoipEnabled>
  <VoipExtension>sample string 22</VoipExtension>
  <VoipPassword>sample string 21</VoipPassword>
  <VoipUsername>sample string 20</VoipUsername>
  <isLsnUser>true</isLsnUser>
</RegistrationDetails>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RegistrationDetails'.

Response Information

Resource Description

RegistrationResult

Name	Type	Additional information
RegistrationMessage	string	None.
Successful	boolean	None.
LoginSuccessful	boolean	None.
LoginMessage	string	None.
Username	string	None.
Password	string	None.
Token	string	None.
FullName	string	None.
Modules	string	None.
Rights	string	None.
ContextMenuActions	string	None.
Tenant	integer	None.
Roles	string	None.
UserImage	string	None.
UserThumbnail	string	None.
UserThumbnailUrl	string	None.
CompanyName	string	None.
CompanyLogo	string	None.
CompanyBackgroundId	integer	None.
UserType	string	None.
AuthenticationMethod	integer	None.
UserId	integer	None.
NewPasswordRequired	boolean	None.
PabxEnabled	boolean	None.
VoipExtension	string	None.
RequiresPhoneExtension	boolean	None.
HasFixedPhoneExtension	boolean	None.
MultiplePabx	boolean	None.
ActiveSession	boolean	None.
Pabxes	Collection of Pabx	None.
UserPreferences	Collection of UserPreferenceEntity	None.
HideDashboard	boolean	None.
TCLink	string	None.
SubAccounts	Collection of ChildLoginAccount	None.
DueTasks	integer	None.
Jwt	string	None.
AppVersion	AppVersionInfo	None.
VoipEnabled	boolean	None.
TimeoutLimit	integer	None.
XyroUrl	string	None.
EnforceDvs	boolean	None.
DvsUrl	string	None.
TrustedUser	boolean	None.
CompanyBackgroundUrl	string	None.
UseOldTickets	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "RegistrationMessage": "sample string 1",
  "Successful": true,
  "LoginSuccessful": true,
  "LoginMessage": "sample string 4",
  "Username": "sample string 5",
  "Password": "sample string 6",
  "Token": "sample string 7",
  "FullName": "sample string 8",
  "Modules": "sample string 9",
  "Rights": "sample string 10",
  "ContextMenuActions": "sample string 11",
  "Tenant": 12,
  "Roles": "sample string 13",
  "UserImage": "sample string 14",
  "UserThumbnail": "sample string 15",
  "UserThumbnailUrl": "sample string 16",
  "CompanyName": "sample string 17",
  "CompanyLogo": "sample string 18",
  "CompanyBackgroundId": 1,
  "UserType": "sample string 19",
  "AuthenticationMethod": 20,
  "UserId": 21,
  "NewPasswordRequired": true,
  "PabxEnabled": true,
  "VoipExtension": "sample string 24",
  "RequiresPhoneExtension": true,
  "HasFixedPhoneExtension": true,
  "MultiplePabx": true,
  "ActiveSession": true,
  "Pabxes": [
    {
      "PABX": 1,
      "TenantId": 2,
      "PABXSystem": "sample string 3",
      "IsActive": true,
      "Version": "sample string 5",
      "PabxUrl": "sample string 6",
      "DisableUserOnCallDecline": true
    },
    {
      "PABX": 1,
      "TenantId": 2,
      "PABXSystem": "sample string 3",
      "IsActive": true,
      "Version": "sample string 5",
      "PabxUrl": "sample string 6",
      "DisableUserOnCallDecline": true
    }
  ],
  "UserPreferences": [
    {
      "KeyId": 1,
      "TenantId": 2,
      "UserId": 3,
      "PrefKey": "sample string 4",
      "PrefValue": "sample string 5"
    },
    {
      "KeyId": 1,
      "TenantId": 2,
      "UserId": 3,
      "PrefKey": "sample string 4",
      "PrefValue": "sample string 5"
    }
  ],
  "HideDashboard": true,
  "TCLink": "sample string 30",
  "SubAccounts": [
    {
      "Username": "sample string 1",
      "Password": "sample string 2",
      "Icon": "sample string 3",
      "TenantName": "sample string 4",
      "TenantId": 5,
      "UrlIdentifier": "sample string 6"
    },
    {
      "Username": "sample string 1",
      "Password": "sample string 2",
      "Icon": "sample string 3",
      "TenantName": "sample string 4",
      "TenantId": 5,
      "UrlIdentifier": "sample string 6"
    }
  ],
  "DueTasks": 31,
  "Jwt": "sample string 32",
  "AppVersion": {
    "ProductVersion": "sample string 1",
    "BuildVersion": "sample string 2",
    "BuildDate": "2026-04-17T11:34:01.8661159+00:00",
    "WebApi": "sample string 4",
    "Xyro": "sample string 5",
    "BusinessServices": "sample string 6",
    "SharedLibraries": "sample string 7",
    "DataModel": "sample string 8",
    "BusinessEntities": "sample string 9"
  },
  "VoipEnabled": true,
  "TimeoutLimit": 33,
  "XyroUrl": "sample string 34",
  "EnforceDvs": true,
  "DvsUrl": "sample string 36",
  "TrustedUser": true,
  "CompanyBackgroundUrl": "sample string 38",
  "UseOldTickets": true
}

text/html

Sample:

{"RegistrationMessage":"sample string 1","Successful":true,"LoginSuccessful":true,"LoginMessage":"sample string 4","Username":"sample string 5","Password":"sample string 6","Token":"sample string 7","FullName":"sample string 8","Modules":"sample string 9","Rights":"sample string 10","ContextMenuActions":"sample string 11","Tenant":12,"Roles":"sample string 13","UserImage":"sample string 14","UserThumbnail":"sample string 15","UserThumbnailUrl":"sample string 16","CompanyName":"sample string 17","CompanyLogo":"sample string 18","CompanyBackgroundId":1,"UserType":"sample string 19","AuthenticationMethod":20,"UserId":21,"NewPasswordRequired":true,"PabxEnabled":true,"VoipExtension":"sample string 24","RequiresPhoneExtension":true,"HasFixedPhoneExtension":true,"MultiplePabx":true,"ActiveSession":true,"Pabxes":[{"PABX":1,"TenantId":2,"PABXSystem":"sample string 3","IsActive":true,"Version":"sample string 5","PabxUrl":"sample string 6","DisableUserOnCallDecline":true},{"PABX":1,"TenantId":2,"PABXSystem":"sample string 3","IsActive":true,"Version":"sample string 5","PabxUrl":"sample string 6","DisableUserOnCallDecline":true}],"UserPreferences":[{"KeyId":1,"TenantId":2,"UserId":3,"PrefKey":"sample string 4","PrefValue":"sample string 5"},{"KeyId":1,"TenantId":2,"UserId":3,"PrefKey":"sample string 4","PrefValue":"sample string 5"}],"HideDashboard":true,"TCLink":"sample string 30","SubAccounts":[{"Username":"sample string 1","Password":"sample string 2","Icon":"sample string 3","TenantName":"sample string 4","TenantId":5,"UrlIdentifier":"sample string 6"},{"Username":"sample string 1","Password":"sample string 2","Icon":"sample string 3","TenantName":"sample string 4","TenantId":5,"UrlIdentifier":"sample string 6"}],"DueTasks":31,"Jwt":"sample string 32","AppVersion":{"ProductVersion":"sample string 1","BuildVersion":"sample string 2","BuildDate":"2026-04-17T11:34:01.8661159+00:00","WebApi":"sample string 4","Xyro":"sample string 5","BusinessServices":"sample string 6","SharedLibraries":"sample string 7","DataModel":"sample string 8","BusinessEntities":"sample string 9"},"VoipEnabled":true,"TimeoutLimit":33,"XyroUrl":"sample string 34","EnforceDvs":true,"DvsUrl":"sample string 36","TrustedUser":true,"CompanyBackgroundUrl":"sample string 38","UseOldTickets":true}

application/xml, text/xml

Sample:

<RegistrationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities">
  <ActiveSession>true</ActiveSession>
  <AppVersion xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Users">
    <d2p1:BuildDate>2026-04-17T11:34:01.8661159+00:00</d2p1:BuildDate>
    <d2p1:BuildVersion>sample string 2</d2p1:BuildVersion>
    <d2p1:BusinessEntities>sample string 9</d2p1:BusinessEntities>
    <d2p1:BusinessServices>sample string 6</d2p1:BusinessServices>
    <d2p1:DataModel>sample string 8</d2p1:DataModel>
    <d2p1:ProductVersion>sample string 1</d2p1:ProductVersion>
    <d2p1:SharedLibraries>sample string 7</d2p1:SharedLibraries>
    <d2p1:WebApi>sample string 4</d2p1:WebApi>
    <d2p1:Xyro>sample string 5</d2p1:Xyro>
  </AppVersion>
  <AuthenticationMethod>20</AuthenticationMethod>
  <CompanyBackgroundId>1</CompanyBackgroundId>
  <CompanyBackgroundUrl>sample string 38</CompanyBackgroundUrl>
  <CompanyLogo>sample string 18</CompanyLogo>
  <CompanyName>sample string 17</CompanyName>
  <ContextMenuActions>sample string 11</ContextMenuActions>
  <DueTasks>31</DueTasks>
  <DvsUrl>sample string 36</DvsUrl>
  <EnforceDvs>true</EnforceDvs>
  <FullName>sample string 8</FullName>
  <HasFixedPhoneExtension>true</HasFixedPhoneExtension>
  <HideDashboard>true</HideDashboard>
  <Jwt>sample string 32</Jwt>
  <LoginMessage>sample string 4</LoginMessage>
  <LoginSuccessful>true</LoginSuccessful>
  <Modules>sample string 9</Modules>
  <MultiplePabx>true</MultiplePabx>
  <NewPasswordRequired>true</NewPasswordRequired>
  <PabxEnabled>true</PabxEnabled>
  <Pabxes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Phone">
    <d2p1:Pabx>
      <d2p1:DisableUserOnCallDecline>true</d2p1:DisableUserOnCallDecline>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PABX>1</d2p1:PABX>
      <d2p1:PABXSystem>sample string 3</d2p1:PABXSystem>
      <d2p1:PabxUrl>sample string 6</d2p1:PabxUrl>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:Version>sample string 5</d2p1:Version>
    </d2p1:Pabx>
    <d2p1:Pabx>
      <d2p1:DisableUserOnCallDecline>true</d2p1:DisableUserOnCallDecline>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PABX>1</d2p1:PABX>
      <d2p1:PABXSystem>sample string 3</d2p1:PABXSystem>
      <d2p1:PabxUrl>sample string 6</d2p1:PabxUrl>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:Version>sample string 5</d2p1:Version>
    </d2p1:Pabx>
  </Pabxes>
  <Password>sample string 6</Password>
  <RequiresPhoneExtension>true</RequiresPhoneExtension>
  <Rights>sample string 10</Rights>
  <Roles>sample string 13</Roles>
  <SubAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Users">
    <d2p1:ChildLoginAccount>
      <d2p1:Icon>sample string 3</d2p1:Icon>
      <d2p1:Password>sample string 2</d2p1:Password>
      <d2p1:TenantId>5</d2p1:TenantId>
      <d2p1:TenantName>sample string 4</d2p1:TenantName>
      <d2p1:UrlIdentifier>sample string 6</d2p1:UrlIdentifier>
      <d2p1:Username>sample string 1</d2p1:Username>
    </d2p1:ChildLoginAccount>
    <d2p1:ChildLoginAccount>
      <d2p1:Icon>sample string 3</d2p1:Icon>
      <d2p1:Password>sample string 2</d2p1:Password>
      <d2p1:TenantId>5</d2p1:TenantId>
      <d2p1:TenantName>sample string 4</d2p1:TenantName>
      <d2p1:UrlIdentifier>sample string 6</d2p1:UrlIdentifier>
      <d2p1:Username>sample string 1</d2p1:Username>
    </d2p1:ChildLoginAccount>
  </SubAccounts>
  <TCLink>sample string 30</TCLink>
  <Tenant>12</Tenant>
  <TimeoutLimit>33</TimeoutLimit>
  <Token>sample string 7</Token>
  <TrustedUser>true</TrustedUser>
  <UseOldTickets>true</UseOldTickets>
  <UserId>21</UserId>
  <UserImage>sample string 14</UserImage>
  <UserPreferences xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Users">
    <d2p1:UserPreferenceEntity>
      <d2p1:KeyId>1</d2p1:KeyId>
      <d2p1:PrefKey>sample string 4</d2p1:PrefKey>
      <d2p1:PrefValue>sample string 5</d2p1:PrefValue>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:UserId>3</d2p1:UserId>
    </d2p1:UserPreferenceEntity>
    <d2p1:UserPreferenceEntity>
      <d2p1:KeyId>1</d2p1:KeyId>
      <d2p1:PrefKey>sample string 4</d2p1:PrefKey>
      <d2p1:PrefValue>sample string 5</d2p1:PrefValue>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:UserId>3</d2p1:UserId>
    </d2p1:UserPreferenceEntity>
  </UserPreferences>
  <UserThumbnail>sample string 15</UserThumbnail>
  <UserThumbnailUrl>sample string 16</UserThumbnailUrl>
  <UserType>sample string 19</UserType>
  <Username>sample string 5</Username>
  <VoipEnabled>true</VoipEnabled>
  <VoipExtension>sample string 24</VoipExtension>
  <XyroUrl>sample string 34</XyroUrl>
  <RegistrationMessage>sample string 1</RegistrationMessage>
  <Successful>true</Successful>
</RegistrationResult>