API Reference

getCustomVendorRejects

The getCustomVendorRejects command enables your organization to retrieve a list of purposes and vendors an end-user has rejected.

Command

The getCustomVendorRejects command in the __uspapi call returns every purpose and vendor an end-user has rejected.

// call the __uspapi() function from the browser console with the getCustomVendorRejects command
__uspapi('getCustomVendorRejects', 1, function(uspData, success){console.log(uspData, success);});
function callback_fn(uspData, success) {
	// your custom callback code can be included here
	console.log(uspData, success)
}

__uspapi('getCustomVendorRejects', 1, callback_fn);

Response

{
  "ccpaApplies": true,
  "rejectedCategories": [
    {
      "id": "5ede9a62ffbdcd235d9923f5",
      "name": "Marketing"
    }
  ],
  "rejectedVendors": [
    {
      "id": "1234d536b9cbf060f19571e0",
      "name": "Vendor Name",
      "vendorType": "CUSTOM"
    }
  ]
}
schema:
    description: Response for getCustomVendorRejects
    type: object
    properties:
      ccpaApplies:
        type: boolean
        description: Is US Privacy - CCPA applicable to end-user visiting your property based on their geographic location?
        example: true
      rejectedCategories:
        type: array
        description: Purposes rejected by end-user
        items:
          type: object
          properties:
            id:
              type: string
              description: ID of the purpose
              example: 5ede9a62ffbdcd235d9923f5
            name:
              type: string
              description: Name of the purpose
              example: Marketing
      rejectedVendors:
        type: array
        description: Vendors rejected by end-user
        items:
          type: object
          properties:
            id:
              type: string
              description: ID of the vendor
              example: 1234d536b9cbf060f19571e0
            name:
              type: string
              description: Name of the purpose
              example: Vendor Name
            vendorType:
              type: string
              description: The vendor type rejected.
              example: CUSTOM