PUT v1/CustomerEmailPreferences

Documentation for 'Put'.

Request Information

Parameters

NameDescriptionAdditional information
customerEmailPreferences 
Documentation for 'customerEmailPreferences'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "customerId": 1,
  "preferences": [
    {
      "enabled": true,
      "emailType": "sample string 1",
      "emailCategory": "sample string 2",
      "id": 3
    },
    {
      "enabled": true,
      "emailType": "sample string 1",
      "emailCategory": "sample string 2",
      "id": 3
    },
    {
      "enabled": true,
      "emailType": "sample string 1",
      "emailCategory": "sample string 2",
      "id": 3
    }
  ]
}

application/xml, text/xml

Sample:
Click to beautify! 
<CustomerEmailPreferences xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Put">
  <CustomerId>1</CustomerId>
  <Preferences>
    <CustomerEmailPreference>
      <Id>3</Id>
      <EmailCategory>sample string 2</EmailCategory>
      <EmailType>sample string 1</EmailType>
      <Enabled>true</Enabled>
    </CustomerEmailPreference>
    <CustomerEmailPreference>
      <Id>3</Id>
      <EmailCategory>sample string 2</EmailCategory>
      <EmailType>sample string 1</EmailType>
      <Enabled>true</Enabled>
    </CustomerEmailPreference>
    <CustomerEmailPreference>
      <Id>3</Id>
      <EmailCategory>sample string 2</EmailCategory>
      <EmailType>sample string 1</EmailType>
      <Enabled>true</Enabled>
    </CustomerEmailPreference>
  </Preferences>
</CustomerEmailPreferences>

application/x-www-form-urlencoded

Sample:
Click to beautify!

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "customerId": 1,
  "preferences": [
    {
      "enabled": true,
      "accountDefault": true,
      "emailType": "sample string 2",
      "emailCategory": "sample string 3"
    },
    {
      "enabled": true,
      "accountDefault": true,
      "emailType": "sample string 2",
      "emailCategory": "sample string 3"
    },
    {
      "enabled": true,
      "accountDefault": true,
      "emailType": "sample string 2",
      "emailCategory": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
Click to beautify! 
<CustomerEmailPreferences xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <CustomerId>1</CustomerId>
  <Preferences>
    <CustomerEmailPreference>
      <AccountDefault>true</AccountDefault>
      <EmailCategory>sample string 3</EmailCategory>
      <EmailType>sample string 2</EmailType>
      <Enabled>true</Enabled>
    </CustomerEmailPreference>
    <CustomerEmailPreference>
      <AccountDefault>true</AccountDefault>
      <EmailCategory>sample string 3</EmailCategory>
      <EmailType>sample string 2</EmailType>
      <Enabled>true</Enabled>
    </CustomerEmailPreference>
    <CustomerEmailPreference>
      <AccountDefault>true</AccountDefault>
      <EmailCategory>sample string 3</EmailCategory>
      <EmailType>sample string 2</EmailType>
      <Enabled>true</Enabled>
    </CustomerEmailPreference>
  </Preferences>
</CustomerEmailPreferences>