POST api/AudienceUsersOptOut/GetByCustomerCode?CustomerCode={CustomerCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerCode		string	Required

Body Parameters

DataSourceRequestAPI

Name	Type	Additional information
Aggregate	string	None.
Filter	string	None.
Group	string	None.
Page	integer	None.
PageSize	integer	None.
Sort	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Aggregate": "sample string 1",
  "Filter": "sample string 2",
  "Group": "sample string 3",
  "Page": 4,
  "PageSize": 5,
  "Sort": "sample string 6"
}

application/xml, text/xml

Sample:

<DataSourceRequestAPI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SM.CentralService.Filter">
  <Aggregate>sample string 1</Aggregate>
  <Filter>sample string 2</Filter>
  <Group>sample string 3</Group>
  <Page>4</Page>
  <PageSize>5</PageSize>
  <Sort>sample string 6</Sort>
</DataSourceRequestAPI>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of AudienceUsersOptOut

Name	Type	Additional information
ID	integer	None.
Firstname	string	String length: inclusive between 0 and 100
Lastname	string	String length: inclusive between 0 and 100
Email	string	String length: inclusive between 0 and 100
MediaID	integer	None.
CustomerCode	string	Required String length: inclusive between 0 and 100
AddedDate	date	None.
IsProcessed	boolean	None.
ProcessDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Firstname": "sample string 2",
    "Lastname": "sample string 3",
    "Email": "sample string 4",
    "MediaID": 5,
    "CustomerCode": "sample string 6",
    "AddedDate": "16/10/2025 02:38",
    "IsProcessed": true,
    "ProcessDate": "16/10/2025 02:38"
  },
  {
    "ID": 1,
    "Firstname": "sample string 2",
    "Lastname": "sample string 3",
    "Email": "sample string 4",
    "MediaID": 5,
    "CustomerCode": "sample string 6",
    "AddedDate": "16/10/2025 02:38",
    "IsProcessed": true,
    "ProcessDate": "16/10/2025 02:38"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAudienceUsersOptOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SM.Data.Models.Audience">
  <AudienceUsersOptOut>
    <AddedDate>2025-10-16T02:38:28.330711+01:00</AddedDate>
    <CustomerCode>sample string 6</CustomerCode>
    <Email>sample string 4</Email>
    <Firstname>sample string 2</Firstname>
    <ID>1</ID>
    <IsProcessed>true</IsProcessed>
    <Lastname>sample string 3</Lastname>
    <MediaID>5</MediaID>
    <ProcessDate>2025-10-16T02:38:28.330711+01:00</ProcessDate>
  </AudienceUsersOptOut>
  <AudienceUsersOptOut>
    <AddedDate>2025-10-16T02:38:28.330711+01:00</AddedDate>
    <CustomerCode>sample string 6</CustomerCode>
    <Email>sample string 4</Email>
    <Firstname>sample string 2</Firstname>
    <ID>1</ID>
    <IsProcessed>true</IsProcessed>
    <Lastname>sample string 3</Lastname>
    <MediaID>5</MediaID>
    <ProcessDate>2025-10-16T02:38:28.330711+01:00</ProcessDate>
  </AudienceUsersOptOut>
</ArrayOfAudienceUsersOptOut>