PUT internal/api/v{version}/{customerId}/notificationtype?includeNonResident={includeNonResident}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

string

Required
includeNonResident

boolean

Default value is False
version

The requested API version

 string

Required

Default value is 1

Body Parameters

Collection of NotificationTypeWithCustomerOptInStatus
NameDescriptionTypeAdditional information
Colour

string

None.
IconUrl

string

None.
Id

integer

None.
Name

string

None.
OptedIn

boolean

None.
Tags

Collection of string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "Colour": "sample string 1",
    "IconUrl": "sample string 2",
    "Id": 3,
    "Name": "sample string 4",
    "OptedIn": true,
    "Tags": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Colour": "sample string 1",
    "IconUrl": "sample string 2",
    "Id": 3,
    "Name": "sample string 4",
    "OptedIn": true,
    "Tags": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

text/javascript

Sample: 
[{"Colour":"sample string 1","IconUrl":"sample string 2","Id":3,"Name":"sample string 4","OptedIn":true,"Tags":["sample string 1","sample string 2"]},{"Colour":"sample string 1","IconUrl":"sample string 2","Id":3,"Name":"sample string 4","OptedIn":true,"Tags":["sample string 1","sample string 2"]}]

application/xml, text/xml

Sample: 
<ArrayOfNotificationTypeWithCustomerOptInStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNITE.External.API.Models">
  <NotificationTypeWithCustomerOptInStatus>
    <Colour>sample string 1</Colour>
    <IconUrl>sample string 2</IconUrl>
    <Id>3</Id>
    <Name>sample string 4</Name>
    <OptedIn>true</OptedIn>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
  </NotificationTypeWithCustomerOptInStatus>
  <NotificationTypeWithCustomerOptInStatus>
    <Colour>sample string 1</Colour>
    <IconUrl>sample string 2</IconUrl>
    <Id>3</Id>
    <Name>sample string 4</Name>
    <OptedIn>true</OptedIn>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
  </NotificationTypeWithCustomerOptInStatus>
</ArrayOfNotificationTypeWithCustomerOptInStatus>

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 'NotificationTypeWithCustomerOptInStatus[]'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.