The Mobile Opt-in and Opt-out API allows users to opt in and out of ID5 tracking via MAIDs.
https://api.id5-sync.com/privacy/mobile-optout?ifa={maid}&ifa_type={ifa_type}
HTTP POST
Content-Type: application/json; charset=UTF-8
| Name | Required | Description |
|---|---|---|
| ifa | x | The Identifier for Advertising (IFA) ID in a UUID format (8-4-4-4-12) i.e. EA7583CD-A667-48BC-B806-42ECB2B48607 |
| ifa_type | x | The type of IFA i.e. GAID, AAID |
200 OK
| Name | Description |
|---|---|
| optout | true if opting out, false if opting in |
| success | true if operation was successful, false otherwise |
{
"optout": true,
"success": true,
"message": ""
}
{
"optout": true,
"success": false
"message": "ifa query parameter must not be null and must have UUID format"
}
https://api.id5-sync.com/privacy/mobile-optin?ifa={maid}&ifa_type={ifa_type}
HTTP POST
Content-Type: application/json; charset=UTF-8
| Name | Required | Description |
|---|---|---|
| ifa | x | The Identifier for Advertising (IFA) ID in a UUID format (8-4-4-4-12) i.e. EA7583CD-A667-48BC-B806-42ECB2B48607 |
| ifa_type | x | The type of IFA i.e. GAID, AAID |
https://api.id5-sync.com/privacy/mobile-optin?ifa=EA7583CD-A667-48BC-B806-42ECB2B48607&ifa_type=GAID
200 OK
| Name | Description |
|---|---|
| optout | true if opting out, false if opting in |
| success | true if operation was successful, false otherwise |
{
"optout": false,
"success": true,
"message": ""
}
{
"optout": false,
"success": false
"message": "ifa query parameter must not be null and must have UUID format"
}