POST /external/api/v3/customer/adddataoptout
Add opt-out by data.
Request Information
URI Parameters
None.
Body Parameters
AddDataOptOutRequestName | Description | Type | Additional information | Nullable |
---|---|---|---|---|
Data |
Collection of customer data. |
Collection of CustomerData |
None |
False |
Request Formats
application/json
Sample:
{ "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" } ] }
application/xml
Sample:
<AddDataOptOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V2.Requests"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models"> <d2p1:CustomerData> <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint> <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId> <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey> <d2p1:IsEncrypted>true</d2p1:IsEncrypted> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:CustomerData> <d2p1:CustomerData> <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint> <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId> <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey> <d2p1:IsEncrypted>true</d2p1:IsEncrypted> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:CustomerData> </Data> </AddDataOptOutRequest>
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.
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. |