GET /external/api/v3/customer/getoptouts

Get a list of opt-outs.

Request Information

URI Parameters

Name	Description	Type	Additional information	Nullable
TransactionDateFilter	Filter on the transaction date.	DateFilter	None	False
OptOutDateFilter	Filter on opt-out date.	DateFilter	None	False
IncludeTestRecords	Include test records. Default value is false.	boolean	None	False
DataFilters	Filter on data.	Collection of CustomerDataFilter	None	False
Cursor	Token to retrieve the next set of data. Token can be found in the NextCursor property of the result. Leave empty for the first cursor.	string	None	False
Limit	Total requested. Max and default are set at 100.	integer	None	False

Body Parameters

None.

Response Information

Resource Description

List of opted-out customers.

GetOptOutCustomersResponse

Name	Description	Type	Additional information	Nullable
OptOuts		Collection of OptOutCustomer	None	False
NextCursor	Token to retrieve the next set of customers - Add token to the Cursor property of the request.	string	None	False

Response Formats

application/json, text/json

Sample:

{
  "OptOuts": [
    {
      "OptOutDate": "2024-12-07T20:31:48.7407323+01:00",
      "Email": "sample string 1",
      "TransactionDate": "2024-12-07T20:31:48.7407323+01:00",
      "SurveyClosedDate": "2024-12-07T20:31:48.7407323+01:00",
      "Data": [
        {
          "CustomerDataColumnId": 1,
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsEncrypted": true,
          "CertificateThumbprint": "sample string 5",
          "EncryptionKey": "sample string 6"
        },
        {
          "CustomerDataColumnId": 1,
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsEncrypted": true,
          "CertificateThumbprint": "sample string 5",
          "EncryptionKey": "sample string 6"
        }
      ],
      "Language": "sample string 2",
      "IsContactRequested": true,
      "IsConcept": true
    },
    {
      "OptOutDate": "2024-12-07T20:31:48.7407323+01:00",
      "Email": "sample string 1",
      "TransactionDate": "2024-12-07T20:31:48.7407323+01:00",
      "SurveyClosedDate": "2024-12-07T20:31:48.7407323+01:00",
      "Data": [
        {
          "CustomerDataColumnId": 1,
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsEncrypted": true,
          "CertificateThumbprint": "sample string 5",
          "EncryptionKey": "sample string 6"
        },
        {
          "CustomerDataColumnId": 1,
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsEncrypted": true,
          "CertificateThumbprint": "sample string 5",
          "EncryptionKey": "sample string 6"
        }
      ],
      "Language": "sample string 2",
      "IsContactRequested": true,
      "IsConcept": true
    }
  ],
  "NextCursor": "sample string 1"
}

application/xml, text/xml

Sample:

<GetOptOutCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V2.Responses">
  <NextCursor xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Domain.Shared.Responses">sample string 1</NextCursor>
  <OptOuts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V2.Models">
    <d2p1:OptOutCustomer>
      <Data xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
        <CustomerData>
          <CertificateThumbprint>sample string 5</CertificateThumbprint>
          <CustomerDataColumnId>1</CustomerDataColumnId>
          <EncryptionKey>sample string 6</EncryptionKey>
          <IsEncrypted>true</IsEncrypted>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </CustomerData>
        <CustomerData>
          <CertificateThumbprint>sample string 5</CertificateThumbprint>
          <CustomerDataColumnId>1</CustomerDataColumnId>
          <EncryptionKey>sample string 6</EncryptionKey>
          <IsEncrypted>true</IsEncrypted>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </CustomerData>
      </Data>
      <Email xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 1</Email>
      <IsConcept xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">true</IsConcept>
      <IsContactRequested xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">true</IsContactRequested>
      <Language xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 2</Language>
      <SurveyClosedDate xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">2024-12-07T20:31:48.7407323+01:00</SurveyClosedDate>
      <TransactionDate xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">2024-12-07T20:31:48.7407323+01:00</TransactionDate>
      <d2p1:OptOutDate>2024-12-07T20:31:48.7407323+01:00</d2p1:OptOutDate>
    </d2p1:OptOutCustomer>
    <d2p1:OptOutCustomer>
      <Data xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
        <CustomerData>
          <CertificateThumbprint>sample string 5</CertificateThumbprint>
          <CustomerDataColumnId>1</CustomerDataColumnId>
          <EncryptionKey>sample string 6</EncryptionKey>
          <IsEncrypted>true</IsEncrypted>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </CustomerData>
        <CustomerData>
          <CertificateThumbprint>sample string 5</CertificateThumbprint>
          <CustomerDataColumnId>1</CustomerDataColumnId>
          <EncryptionKey>sample string 6</EncryptionKey>
          <IsEncrypted>true</IsEncrypted>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </CustomerData>
      </Data>
      <Email xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 1</Email>
      <IsConcept xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">true</IsConcept>
      <IsContactRequested xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">true</IsContactRequested>
      <Language xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 2</Language>
      <SurveyClosedDate xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">2024-12-07T20:31:48.7407323+01:00</SurveyClosedDate>
      <TransactionDate xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">2024-12-07T20:31:48.7407323+01:00</TransactionDate>
      <d2p1:OptOutDate>2024-12-07T20:31:48.7407323+01:00</d2p1:OptOutDate>
    </d2p1:OptOutCustomer>
  </OptOuts>
</GetOptOutCustomersResponse>

Response Status Codes

Status Code	Name	Description
200	OK	The request has succeeded.
400	Bad Request	Fulfilling the request would cause an invalid state. Request needs modification.
401	Unauthorized	Missing or invalid authentication token.
403	Forbidden	Server refuses to authorize the request.
408	Request Timeout	The server timed out waiting for the request.
429	Too Many Requests	Too many requests in a given amount of time.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	Service Unavailable	The server is unable to proces the request at the moment, try again later.