POST users

Create User Roles: ApiRole

Request Information

URI Parameters

None.

Body Parameters

Collection of UserCreateData to create new users

Collection of UserCreateData
NameDescriptionTypeAdditional information
Email

User email

string

Required

CustomerID

User customer ID

integer

Required

FirstName

User First name

string

None.

LastName

User last name

string

None.

Phone

User phone

string

None.

Mobile

User mobile

string

None.

Roles

User roles

Collection of string

None.

Language

User language

string

None.

Culture

User culture

string

None.

TimeZone

User timezone Find C# timezones here

string

None.

MailSubject

User mail subject

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "Email": "sample string 1",
    "CustomerID": 2,
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Phone": "sample string 5",
    "Mobile": "sample string 6",
    "Roles": [
      "sample string 1",
      "sample string 2"
    ],
    "Language": "sample string 7",
    "Culture": "sample string 8",
    "TimeZone": "sample string 9",
    "MailSubject": "sample string 10"
  },
  {
    "Email": "sample string 1",
    "CustomerID": 2,
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Phone": "sample string 5",
    "Mobile": "sample string 6",
    "Roles": [
      "sample string 1",
      "sample string 2"
    ],
    "Language": "sample string 7",
    "Culture": "sample string 8",
    "TimeZone": "sample string 9",
    "MailSubject": "sample string 10"
  }
]

application/xml, text/xml

Sample:
<ArrayOfUserCreateData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserCreateData>
    <Email>sample string 1</Email>
    <CustomerID>2</CustomerID>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <Phone>sample string 5</Phone>
    <Mobile>sample string 6</Mobile>
    <Roles>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Roles>
    <Language>sample string 7</Language>
    <Culture>sample string 8</Culture>
    <TimeZone>sample string 9</TimeZone>
    <MailSubject>sample string 10</MailSubject>
  </UserCreateData>
  <UserCreateData>
    <Email>sample string 1</Email>
    <CustomerID>2</CustomerID>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <Phone>sample string 5</Phone>
    <Mobile>sample string 6</Mobile>
    <Roles>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Roles>
    <Language>sample string 7</Language>
    <Culture>sample string 8</Culture>
    <TimeZone>sample string 9</TimeZone>
    <MailSubject>sample string 10</MailSubject>
  </UserCreateData>
</ArrayOfUserCreateData>

Response Information

Resource Description

Returns newly created users

Collection of UserCreateResponse
NameDescriptionTypeAdditional information
Email

User email

string

None.

Status

Status of the UserCreateRequest["Success", "Failed"]

string

None.

StatusCode

Status code of the UserCreateRequest["Success", "Failed"]

InviteResponse_Values

None.

ErrorMessage

Error message in case of Status="Failed"

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Email": "sample string 1",
    "Status": "sample string 2",
    "StatusCode": "NotAssigned",
    "ErrorMessage": "sample string 3"
  },
  {
    "Email": "sample string 1",
    "Status": "sample string 2",
    "StatusCode": "NotAssigned",
    "ErrorMessage": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfUserCreateResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserCreateResponse>
    <Email>sample string 1</Email>
    <Status>sample string 2</Status>
    <StatusCode>NotAssigned</StatusCode>
    <ErrorMessage>sample string 3</ErrorMessage>
  </UserCreateResponse>
  <UserCreateResponse>
    <Email>sample string 1</Email>
    <Status>sample string 2</Status>
    <StatusCode>NotAssigned</StatusCode>
    <ErrorMessage>sample string 3</ErrorMessage>
  </UserCreateResponse>
</ArrayOfUserCreateResponse>