POST api/Member/UpdateMemberPreference

Request Information

URI Parameters

None.

Body Parameters

MemberPreferenceRequestDTO
NameDescriptionTypeAdditional information
MembID

string

None.

CompanyCode

string

None.

CommunicationPreferences

Collection of MemberPreferenceOptOuts

None.

SourceSystemUserId

string

None.

Request Formats

text/json, application/json

Sample:
Request sample for request 

--------------------------------------------------------------------------------------------------------------------------------

{
  "MembID": "sample string 1",
  "CompanyCode": "sample string 2",
  "CommunicationPreferences": [
    {
      "CampaignCategoryID": 1,
      "CampaignCategory": "sample string 2",
      "CampaignID": 3,
      "CampaignName": "sample string 4",
      "CommunicationTypeID": 5,
      "CommunicationType": "sample string 6",
      "OptedOut": "sample string 7"
    },
    {
      "CampaignCategoryID": 1,
      "CampaignCategory": "sample string 2",
      "CampaignID": 3,
      "CampaignName": "sample string 4",
      "CommunicationTypeID": 5,
      "CommunicationType": "sample string 6",
      "OptedOut": "sample string 7"
    }
  ],
  "SourceSystemUserId": "sample string 3"
}

--------------------------------------------------------------------------------------------------------------------------------


text/xml, application/xml

Sample:
Request sample for request 

--------------------------------------------------------------------------------------------------------------------------------

<MemberPreferenceRequestDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CommunicationPreferences>
    <MemberPreferenceOptOuts>
      <CampaignCategory>sample string 2</CampaignCategory>
      <CampaignCategoryID>1</CampaignCategoryID>
      <CampaignID>3</CampaignID>
      <CampaignName>sample string 4</CampaignName>
      <CommunicationType>sample string 6</CommunicationType>
      <CommunicationTypeID>5</CommunicationTypeID>
      <OptedOut>sample string 7</OptedOut>
    </MemberPreferenceOptOuts>
    <MemberPreferenceOptOuts>
      <CampaignCategory>sample string 2</CampaignCategory>
      <CampaignCategoryID>1</CampaignCategoryID>
      <CampaignID>3</CampaignID>
      <CampaignName>sample string 4</CampaignName>
      <CommunicationType>sample string 6</CommunicationType>
      <CommunicationTypeID>5</CommunicationTypeID>
      <OptedOut>sample string 7</OptedOut>
    </MemberPreferenceOptOuts>
  </CommunicationPreferences>
  <CompanyCode>sample string 2</CompanyCode>
  <MembID>sample string 1</MembID>
  <SourceSystemUserId>sample string 3</SourceSystemUserId>
</MemberPreferenceRequestDTO>

--------------------------------------------------------------------------------------------------------------------------------


application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

text/json, application/json

Sample:

--------------------------------------------------------------------------------------------------------------------------------

{
  "ConfirmationNumber": "sample string 1",
  "Notes": "sample string 2",
  "ProcessingStatusList": [
    {
      "StatusCode": "sample string 1",
      "StatusDescription": "sample string 2"
    },
    {
      "StatusCode": "sample string 1",
      "StatusDescription": "sample string 2"
    }
  ]
}

--------------------------------------------------------------------------------------------------------------------------------


text/xml, application/xml

Sample:

--------------------------------------------------------------------------------------------------------------------------------

<ConfirmationDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.Core.Web.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ProcessingStatusList xmlns:a="http://schemas.datacontract.org/2004/07/AHC.Core">
    <a:ProcessingStatus>
      <a:StatusCode>sample string 1</a:StatusCode>
      <a:StatusDescription>sample string 2</a:StatusDescription>
    </a:ProcessingStatus>
    <a:ProcessingStatus>
      <a:StatusCode>sample string 1</a:StatusCode>
      <a:StatusDescription>sample string 2</a:StatusDescription>
    </a:ProcessingStatus>
  </ProcessingStatusList>
  <ConfirmationNumber>sample string 1</ConfirmationNumber>
  <EstimatedFulfillmentDate>2026-06-03T09:19:53.7516907-07:00</EstimatedFulfillmentDate>
  <Notes>sample string 2</Notes>
</ConfirmationDTO>

--------------------------------------------------------------------------------------------------------------------------------