Refreshing envelopes - identified

Refreshing envelopes is an important step to keep the match rate as high as possible for your users. Existing envelopes can be exchanged for fresh envelopes by calling this endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Server-to-Server Integrations

When retrieving or refreshing the ATS Envelopes, publishers integrating server-to-server are required to include the X-Forwarded-For header to ensure that the client-side IP address is within the approved countries tied to the ATS Placement

Query Params
int32
Defaults to 14

Your LiveRamp-provided placement ID

int32
Defaults to 19

The envelope type. Use '19' for regular ATS envelopes.

string
Defaults to ApN4iB_v5QsHRLDYDvEPmdhbdaknzxNA3-4Al2d_JFnP6IlH9cApY45f3ohEbriGAzRGVmnizG1iE8bV9MK66Dde9wCektrTCHCD8wKmRkimgOJQyfzwWRfMljKUlcN3TE0k

The envelope value

int32
Defaults to 4

The type of consent passed to the API. Use "3" to represent CCPA US Privacy String or "4" to represent a TCFv2 compatible string for EU/EEA. Consent is required for processing in the EU.

string
Defaults to 7

The valid corresponding GPP section ID.

string
Defaults to CPUCbs9PUDXghADABCENCBCoAP_AAEJAAAAADGwBAAGABPADCAY0BjYAgADAAngBhAMaAAA.YAAAAAAAA4AA

The consent string

string
Defaults to DBABLA~BVQqAAAAAAA

The GPP consent string.

Headers
string
Defaults to https://example.com

An origin domain that was included in the privacy review for the Placement ID you're using

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json
text/plain