This API allows Liftoff’s exchange partners and customers to submit GDPR-compliant opt-out requests to remove user data.
HTTP request
POST https://analytics.liftoff.io/#path#Your URL and credentials can be provided from Liftoff on request. Credentials should be passed via HTTP Basic Authentication.
JSON parameters
The request body JSON should contain the required JSON keys and value types listed below.
| JSON key | Type | Required | Note |
|---|---|---|---|
ts | int | No | Timestamp. |
device-ids | []string | Yes | A list of device IDs to be opted-out. Provide proper casing: lowercase for GAID and uppercase for IDFA. |
device-id-type | string | No | If not present, the device ID type will be inferred from the casing or specified app store platform (e.g., "idfa", "gaid"). |
test | bool | Yes | Used to specify whether or not the request is a test. |
device-id-sha1 | SHA1 string | No | If not present, this will be derived from the provided device-ids. |
app-store-ids | []string | No | If present, data will only be opted-out for the selected app(s). |
Example request
curl --request POST \
--header "Content-Type: application/json" \
--user user:secret \
--data '{"ts":1628721059, "device-ids":["79C2332A-D699-4EE8-B5AE-DF5C3C6E9A3E"],"device-id-type":"idfa","test":true}' \
https://analytics.liftoff.io/opt_out/v3/liftoffResult
HTTP status codes
200: Accepted for processing
Once an opt-out request has been received, Liftoff will remove the data from our systems and promptly notify our partners of the request.
202: Accepted but not processed
If an opt-out request contains all zero device IDs, the request will not continue to be processed.
400: Request failed
Reasons for failed request:
- Request body is missing.
- Request body JSON is not formatted as specified under JSON parameters.
- Device_ids are not present in the request body.
- Device ID within Device_ids is not valid.
401: Unauthorized
Reasons for failed authorization:
- Username and password cannot be parsed from the request header.
- Credentials are not valid for the specified HTTP request.
Comments
0 comments
Article is closed for comments.