PUT api/UpdateProfile/UnSubscribe

Request Information

URI Parameters

None.

Body Parameters

UnsubscribeRequestVM
NameDescriptionTypeAdditional information
AccountId

string

Required

Email

string

None.

MobileNumber

string

None.

MobileCountryCode

string

None.

UnsubscribeReason

UnSubscribeCommunicationReason

None.

ContactId

string

None.

UnsubscribeInitiatedModuleId

string

None.

UnSubscribeForSendSummaryId

string

None.

InitiatedFromModule

UnSubscribeInitiatedModule

None.

IsDeleteContactPermanently

boolean

None.

CommunicationFrequencySettings

CommunicatonFrequencySettingsVM

None.

IsUnSubscribe

boolean

None.

NumberOfDaysForUnSubscribe

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountId": "sample string 1",
  "Email": "sample string 2",
  "MobileNumber": "sample string 3",
  "MobileCountryCode": "sample string 4",
  "UnsubscribeReason": "None",
  "ContactId": "sample string 5",
  "UnsubscribeInitiatedModuleId": "sample string 6",
  "UnSubscribeForSendSummaryId": "sample string 7",
  "InitiatedFromModule": "None",
  "IsDeleteContactPermanently": true,
  "CommunicationFrequencySettings": {
    "IntervalLength": 1,
    "IntervalType": "Week"
  },
  "IsUnSubscribe": true,
  "NumberOfDaysForUnSubscribe": 10
}

application/xml, text/xml

Sample:
<UnsubscribeRequestVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.RequestViewModels.UnsubscribeViewModels">
  <AccountId>sample string 1</AccountId>
  <CommunicationFrequencySettings>
    <IntervalLength>1</IntervalLength>
    <IntervalType>Week</IntervalType>
  </CommunicationFrequencySettings>
  <ContactId>sample string 5</ContactId>
  <Email>sample string 2</Email>
  <InitiatedFromModule>None</InitiatedFromModule>
  <IsDeleteContactPermanently>true</IsDeleteContactPermanently>
  <IsUnSubscribe>true</IsUnSubscribe>
  <MobileCountryCode>sample string 4</MobileCountryCode>
  <MobileNumber>sample string 3</MobileNumber>
  <NumberOfDaysForUnSubscribe>10</NumberOfDaysForUnSubscribe>
  <UnSubscribeForSendSummaryId>sample string 7</UnSubscribeForSendSummaryId>
  <UnsubscribeInitiatedModuleId>sample string 6</UnsubscribeInitiatedModuleId>
  <UnsubscribeReason>None</UnsubscribeReason>
</UnsubscribeRequestVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.