Documentation for PUT api/Revolution/PushNotification/UserPreference?repDID={repDID}

PUT api/Revolution/PushNotification/UserPreference?repDID={repDID}

Saves the user's notification preferences.

Request Information

URI Parameters

Name	Description	Type	Additional information
repDID	the user DID saving their preferences	string	Required

Body Parameters

The user preferences

RevolutionUserNotificationPreference

Name	Description	Type	Additional information
IsEmailEnabled	Dictates whether or not the user wants to receive emails for alerts	boolean	None.
Email	The user's email to use for Alerts	string	None.
IsSMSEnabled	Dictates whether or not the user wants to receive SMS for alerts	boolean	None.
SMSPhoneNumber	The user's phone number to use for Alerts	string	None.
PhoneCarrierId	The Carrier (from ~/api/Revolution/PhoneCarrier) associated with the phone number	integer	None.

Request Formats

application/xml, text/xml

Sample:

<RevolutionUserNotificationPreference>
  <IsEmailEnabled>True</IsEmailEnabled>
  <Email>sample string 1</Email>
  <IsSMSEnabled>True</IsSMSEnabled>
  <SMSPhoneNumber>sample string 2</SMSPhoneNumber>
  <PhoneCarrierId>1</PhoneCarrierId>
</RevolutionUserNotificationPreference>

application/json, text/json

Sample:

{
  "IsEmailEnabled": true,
  "Email": "sample string 1",
  "IsSMSEnabled": true,
  "SMSPhoneNumber": "sample string 2",
  "PhoneCarrierId": 1
}

application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

RevolutionUserNotificationPreference

Name	Description	Type	Additional information
IsEmailEnabled	Dictates whether or not the user wants to receive emails for alerts	boolean	None.
Email	The user's email to use for Alerts	string	None.
IsSMSEnabled	Dictates whether or not the user wants to receive SMS for alerts	boolean	None.
SMSPhoneNumber	The user's phone number to use for Alerts	string	None.
PhoneCarrierId	The Carrier (from ~/api/Revolution/PhoneCarrier) associated with the phone number	integer	None.

Response Formats

application/xml, text/xml

Sample:

<RevolutionUserNotificationPreference>
  <IsEmailEnabled>True</IsEmailEnabled>
  <Email>sample string 1</Email>
  <IsSMSEnabled>True</IsSMSEnabled>
  <SMSPhoneNumber>sample string 2</SMSPhoneNumber>
  <PhoneCarrierId>1</PhoneCarrierId>
</RevolutionUserNotificationPreference>

application/json, text/json

Sample:

{
  "IsEmailEnabled": true,
  "Email": "sample string 1",
  "IsSMSEnabled": true,
  "SMSPhoneNumber": "sample string 2",
  "PhoneCarrierId": 1
}