Overview

The Mobile Opt-in and Opt-out API allows users to opt in and out of ID5 tracking via MAIDs.

Opt Out Request

Example URL

https://api.id5-sync.com/privacy/mobile-optout?ifa={maid}&ifa_type={ifa_type}

Request Type

HTTP POST

Request Headers

Content-Type: application/json; charset=UTF-8

Available Parameters

Querystring

Example Mobile Opt Out Request

https://api.id5-sync.com/privacy/mobile-optout?ifa=EA7583CD-A667-48BC-B806-42ECB2B48607&ifa_type=GAID

Mobile Opt Out Response

Successful Response

HTTP Status Code

200 OK

Response Body

Example Successful Response

{
  "optout": true,
  "success": true,
  "message": ""
}

Unsuccessful Response

Example Unsuccessful Response

{
  "optout": true,
  "success": false
  "message": "ifa query parameter must not be null and must have UUID format"
}

Opt In Request

Example URL

https://api.id5-sync.com/privacy/mobile-optin?ifa={maid}&ifa_type={ifa_type}

Request Type

HTTP POST

Request Headers

Content-Type: application/json; charset=UTF-8

Available Parameters

Querystring

Example Mobile Opt Out Request

https://api.id5-sync.com/privacy/mobile-optin?ifa=EA7583CD-A667-48BC-B806-42ECB2B48607&ifa_type=GAID

Mobile Opt Out Response

Successful Response

HTTP Status Code

200 OK

Response Body

Example Successful Response

{
  "optout": false,
  "success": true,
  "message": ""
}

Unsuccessful Response

Example Unsuccessful Response

{
  "optout": false,
  "success": false
  "message": "ifa query parameter must not be null and must have UUID format"
}