Data Opt-Out

Abstract

Use this API endpoint to completely opt out one or more sets of users from your entire taxonomy hierarchy.

Note

This Opt-out will also remove users from the stored in-house mapping table use for measurement. Opt-outs are executed in a SLA of 24 hours.

Post Call Examples

Request

POST /v1/audience/opt-out
HTTP/1.1 Host: datax.yahooapis.com
Content-Type: multipart/form-data;boundary=xyz

--xyz
Content-Type: application/json;charset=UTF-8 Content-Disposition: form-data; name="metadata"
{
                        "description" : "Partner Match PXID Opt-Out",
                 "extensions" : { "urnType" : "PXID" }
}
--xyz
Content-Type: application/octet-stream;charset=UTF-8 Content-Disposition: form-data; name="data"

< bz2 compressed data >
--xyz--

Successful Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8 Date: Sun, 30 Aug 2020 12:29:09 GMT

{
                  "resourceType" : "datax-opt-out",
                       "resourceId" : "133712R013759Z662589132",
                        "description" : "user opt outs", "createTime" : "2020-30-08T12:19:17Z",
                  "links" : [
                               {
                                    "rel"   : "self",
                                        "href" : "https://datax.yahooapis.com/v1/link/W7UkPecaa1o9GKdaLzk-"
                                },
                                {
                                        "rel"   : "describes",
                                        "href" : "https://datax.yahooapis.com/v1/link/eLfkc1UksG1whQc214-"
                               }
                 ],
                 "status" : {
                         "state" : "PROCESSING",
                                "lastUpdateTime" : "2020-08-30T19:22:17Z"
                       },
                 "extensions" : { "urnType" : “PXID"
                                }
}

Text Representation

A row (unit of data) in the payload must be a simple text value of the URN that you need to opt out.

URN

• The user identifier URN must conform to urnType specified in the metadata of the POST call.

• ResourceType for this representation is datax-opt-out.

• If you send us data using multiple URNs and urnTypes of the same user, it is best to opt-out each one of these URNs. You will need to make a separate opt-out call for each urnType.

Representation Example

A payload to opt out three users with PXID URNs 29ff2111, 07feb252 and f10d53af will look like the following prior to compression(.bz2):

29ff2111,
07feb252,
F10d53af