POST /external/api/v3/customer/checkoptouts

Check whether customers are opt-out by email or data.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information	Nullable
Customers		Collection of CheckOptOutCustomer	Required	False

Request Formats

application/json

Sample:

{
  "Customers": [
    {
      "Email": "sample string 1",
      "CustomerDataColumns": [
        {
          "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"
        }
      ]
    },
    {
      "Email": "sample string 1",
      "CustomerDataColumns": [
        {
          "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"
        }
      ]
    }
  ]
}

application/xml

Sample:

<GetCheckOptOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Requests">
  <Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Models">
    <d2p1:CheckOptOutCustomer>
      <d2p1:CustomerDataColumns xmlns:d4p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
        <d4p1:CustomerData>
          <d4p1:CertificateThumbprint>sample string 5</d4p1:CertificateThumbprint>
          <d4p1:CustomerDataColumnId>1</d4p1:CustomerDataColumnId>
          <d4p1:EncryptionKey>sample string 6</d4p1:EncryptionKey>
          <d4p1:IsEncrypted>true</d4p1:IsEncrypted>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:CustomerData>
        <d4p1:CustomerData>
          <d4p1:CertificateThumbprint>sample string 5</d4p1:CertificateThumbprint>
          <d4p1:CustomerDataColumnId>1</d4p1:CustomerDataColumnId>
          <d4p1:EncryptionKey>sample string 6</d4p1:EncryptionKey>
          <d4p1:IsEncrypted>true</d4p1:IsEncrypted>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:CustomerData>
      </d2p1:CustomerDataColumns>
      <d2p1:Email>sample string 1</d2p1:Email>
    </d2p1:CheckOptOutCustomer>
    <d2p1:CheckOptOutCustomer>
      <d2p1:CustomerDataColumns xmlns:d4p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
        <d4p1:CustomerData>
          <d4p1:CertificateThumbprint>sample string 5</d4p1:CertificateThumbprint>
          <d4p1:CustomerDataColumnId>1</d4p1:CustomerDataColumnId>
          <d4p1:EncryptionKey>sample string 6</d4p1:EncryptionKey>
          <d4p1:IsEncrypted>true</d4p1:IsEncrypted>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:CustomerData>
        <d4p1:CustomerData>
          <d4p1:CertificateThumbprint>sample string 5</d4p1:CertificateThumbprint>
          <d4p1:CustomerDataColumnId>1</d4p1:CustomerDataColumnId>
          <d4p1:EncryptionKey>sample string 6</d4p1:EncryptionKey>
          <d4p1:IsEncrypted>true</d4p1:IsEncrypted>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:CustomerData>
      </d2p1:CustomerDataColumns>
      <d2p1:Email>sample string 1</d2p1:Email>
    </d2p1:CheckOptOutCustomer>
  </Customers>
</GetCheckOptOutRequest>

Response Information

Resource Description

Collection of GetCheckOptOutResponse

Name	Description	Type	Additional information	Nullable
OptOut	Describes wheter customer is on opt-out list.	boolean	None	False
Email	Check if email is on the opt-out list.	string	None	False
CustomerDataColumns	Data which has to be checked on opt-out.	Collection of CustomerData	None	False

Response Formats

application/json, text/json

Sample:

[
  {
    "OptOut": true,
    "Email": "sample string 2",
    "CustomerDataColumns": [
      {
        "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"
      }
    ]
  },
  {
    "OptOut": true,
    "Email": "sample string 2",
    "CustomerDataColumns": [
      {
        "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"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetCheckOptOutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Responses">
  <GetCheckOptOutResponse>
    <CustomerDataColumns xmlns:d3p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Models">
      <d3p1:CustomerData>
        <d3p1:CertificateThumbprint>sample string 5</d3p1:CertificateThumbprint>
        <d3p1:CustomerDataColumnId>1</d3p1:CustomerDataColumnId>
        <d3p1:EncryptionKey>sample string 6</d3p1:EncryptionKey>
        <d3p1:IsEncrypted>true</d3p1:IsEncrypted>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:CustomerData>
      <d3p1:CustomerData>
        <d3p1:CertificateThumbprint>sample string 5</d3p1:CertificateThumbprint>
        <d3p1:CustomerDataColumnId>1</d3p1:CustomerDataColumnId>
        <d3p1:EncryptionKey>sample string 6</d3p1:EncryptionKey>
        <d3p1:IsEncrypted>true</d3p1:IsEncrypted>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:CustomerData>
    </CustomerDataColumns>
    <Email xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Models">sample string 2</Email>
    <OptOut>true</OptOut>
  </GetCheckOptOutResponse>
  <GetCheckOptOutResponse>
    <CustomerDataColumns xmlns:d3p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Models">
      <d3p1:CustomerData>
        <d3p1:CertificateThumbprint>sample string 5</d3p1:CertificateThumbprint>
        <d3p1:CustomerDataColumnId>1</d3p1:CustomerDataColumnId>
        <d3p1:EncryptionKey>sample string 6</d3p1:EncryptionKey>
        <d3p1:IsEncrypted>true</d3p1:IsEncrypted>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:CustomerData>
      <d3p1:CustomerData>
        <d3p1:CertificateThumbprint>sample string 5</d3p1:CertificateThumbprint>
        <d3p1:CustomerDataColumnId>1</d3p1:CustomerDataColumnId>
        <d3p1:EncryptionKey>sample string 6</d3p1:EncryptionKey>
        <d3p1:IsEncrypted>true</d3p1:IsEncrypted>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:CustomerData>
    </CustomerDataColumns>
    <Email xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Models">sample string 2</Email>
    <OptOut>true</OptOut>
  </GetCheckOptOutResponse>
</ArrayOfGetCheckOptOutResponse>

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.