POST api/SaveUser

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ExternalUserId	string	None.
FirstName	string	None.
FullName	string	None.
MobileNumber	string	None.
Email	string	None.
Groups	Collection of CustomerGroupUpdateModel	None.
SecondaryMobileNumber	string	None.
SecondaryEmail	string	None.
ApplicationId	integer	None.
ApplicationSecretKey	string	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "ExternalUserId": "sample string 1",
  "FirstName": "sample string 2",
  "FullName": "sample string 3",
  "MobileNumber": "sample string 4",
  "Email": "sample string 5",
  "Groups": [
    {
      "GroupId": 1,
      "GroupKey": "sample string 1",
      "IsEnabled": true
    },
    {
      "GroupId": 1,
      "GroupKey": "sample string 1",
      "IsEnabled": true
    }
  ],
  "SecondaryMobileNumber": "sample string 6",
  "SecondaryEmail": "sample string 7",
  "ApplicationId": 8,
  "ApplicationSecretKey": "sample string 9"
}

application/xml, text/xml

Sample:

<SaveUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AltaSoft.Notifications.Web.Models.API">
  <ApplicationId>8</ApplicationId>
  <ApplicationSecretKey>sample string 9</ApplicationSecretKey>
  <Email>sample string 5</Email>
  <ExternalUserId>sample string 1</ExternalUserId>
  <FirstName>sample string 2</FirstName>
  <FullName>sample string 3</FullName>
  <Groups xmlns:d2p1="http://schemas.datacontract.org/2004/07/AltaSoft.Notifications.DAL">
    <d2p1:CustomerGroupUpdateModel>
      <d2p1:GroupId>1</d2p1:GroupId>
      <d2p1:GroupKey>sample string 1</d2p1:GroupKey>
      <d2p1:IsEnabled>true</d2p1:IsEnabled>
    </d2p1:CustomerGroupUpdateModel>
    <d2p1:CustomerGroupUpdateModel>
      <d2p1:GroupId>1</d2p1:GroupId>
      <d2p1:GroupKey>sample string 1</d2p1:GroupKey>
      <d2p1:IsEnabled>true</d2p1:IsEnabled>
    </d2p1:CustomerGroupUpdateModel>
  </Groups>
  <MobileNumber>sample string 4</MobileNumber>
  <SecondaryEmail>sample string 7</SecondaryEmail>
  <SecondaryMobileNumber>sample string 6</SecondaryMobileNumber>
</SaveUserModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResult

Name	Type	Additional information
IsSuccess	boolean	None.
Error	string	None.
ErrorDetails	string	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "IsSuccess": true,
  "Error": "sample string 2",
  "ErrorDetails": "sample string 3"
}

application/xml, text/xml

Sample:

<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AltaSoft.Notifications.Web.Models.API">
  <Error>sample string 2</Error>
  <ErrorDetails>sample string 3</ErrorDetails>
  <IsSuccess>true</IsSuccess>
</APIResult>