POST /AUDIENCE/OPT-OUT
  • 1 Minute to read

    POST /AUDIENCE/OPT-OUT


      Article summary

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

      POST Call Example

      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" : "user opt outs",
              "extensions" : { "urnType" : "IXID" }
      }
      --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, 19 May 2013 12:29:09 GMT
      
      {
              "resourceType" : "datax-opt-out",
              "resourceId" : "130712T013759Z6625891365",
              "description" : "user opt outs", "createTime" : "2013-19-05T12: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" : "2017-10-08T19:22:17Z"
              },
              "extensions" : { "urnType" : “IDFA"
              }
      }

      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

      Note

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

      2. ResourceType for this representation is “datax-opt-out”.

      3. If you sent us data using multiple URNs and urnTypes of the same user, it is best to opt-out each one 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 eyuid URNs 99ff2333, 07feb252 and f10d53af will look like the following prior to compression:

      99ff2333
      07feb252
      F10d53af


      Was this article helpful?

      What's Next