1. v3
  2. Users
  3. POST - 3/users

Definition

POST - 3/users

Required roles: AccountAdministrator

Request information

Sample: 
{
  "Email": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Company": "sample string 4",
  "Department": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "City": "sample string 8",
  "PostalCode": "sample string 9",
  "State": "sample string 10",
  "Province": "sample string 11",
  "CountryCode": "sample string 12",
  "PhoneNumber": "sample string 13",
  "LanguageCode": "sample string 14",
  "TimezoneId": 15,
  "Use12hTimeFormat": true,
  "DateFormat": "sample string 17",
  "DecimalSymbol": "sample string 18",
  "Roles": "sample string 19",
  "Rights": {
    "CreateSurveys": true,
    "LaunchSurveys": true,
    "AnalyzeSurveys": true,
    "AccessAllSurveys": true,
    "AccessAllContactLists": true,
    "ManageContacts": true,
    "DistributeSMS": true,
    "DistributePanels": true,
    "ManageThemes": true,
    "EditAppearance": true,
    "ManageNotifications": true
  },
  "SurveyList": "sample string 20"
}
Sample: 
<CreateUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <City>sample string 8</City>
  <Company>sample string 4</Company>
  <CountryCode>sample string 12</CountryCode>
  <DateFormat>sample string 17</DateFormat>
  <DecimalSymbol>sample string 18</DecimalSymbol>
  <Department>sample string 5</Department>
  <Email>sample string 1</Email>
  <FirstName>sample string 2</FirstName>
  <LanguageCode>sample string 14</LanguageCode>
  <LastName>sample string 3</LastName>
  <PhoneNumber>sample string 13</PhoneNumber>
  <PostalCode>sample string 9</PostalCode>
  <Province>sample string 11</Province>
  <Rights>
    <AccessAllContactLists>true</AccessAllContactLists>
    <AccessAllSurveys>true</AccessAllSurveys>
    <AnalyzeSurveys>true</AnalyzeSurveys>
    <CreateSurveys>true</CreateSurveys>
    <DistributePanels>true</DistributePanels>
    <DistributeSMS>true</DistributeSMS>
    <EditAppearance>true</EditAppearance>
    <LaunchSurveys>true</LaunchSurveys>
    <ManageContacts>true</ManageContacts>
    <ManageNotifications>true</ManageNotifications>
    <ManageThemes>true</ManageThemes>
  </Rights>
  <Roles>sample string 19</Roles>
  <State>sample string 10</State>
  <SurveyList>sample string 20</SurveyList>
  <TimezoneId>15</TimezoneId>
  <Use12hTimeFormat>true</Use12hTimeFormat>
</CreateUserRequest>

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type CreateUserResponse
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2026-09-09T16:23:13.3998478Z",
    "IsFiltered": true
  },
  "Data": {
    "UserId": 1
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <UserId>1</UserId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2026-09-09T16:23:13.3998478+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>