overlay: 1.0.0
info:
title: API Evangelist enhancements for the Audience Tracking Consent API
version: 1.0.0
extends: openapi/immutable-tracking-consent-api-openapi.yml
x-provenance:
generated: '2026-10-21'
method: generated
source:
- openapi/immutable-tracking-consent-api-openapi.yml
- overlays (prior combined zkEVM/Audience overlays, 2026-08-23)
note: Non-destructive Overlay 1.0.0 for one of the 16 per-API contracts split from the two published
Immutable specs. Actions carried over from the earlier combined overlay only where the target path
or security scheme exists in this file. The original spec is never mutated.
actions:
- target: $.info
update:
x-provider: Immutable
x-provider-url: https://www.immutable.com
x-docs: https://docs.immutable.com/docs/products/audience/analytics/rest-api
x-source-spec: https://docs.immutable.com/api-specs/audience.json
x-data-dictionary: https://docs.immutable.com/docs/products/audience/analytics/data-dictionary
- target: $
update:
x-conventions: conventions/immutable-conventions.yml
x-errors: errors/immutable-problem-types.yml
x-webhooks: asyncapi/immutable-webhooks.yml
- target: $.paths['/v1/audience/tracking-consent'].put
update:
x-reversible: true
x-reversibility-note: Last-write-wins consent state; re-call with the prior value to reverse.
- target: $.components.securitySchemes.ImmutableApiKey
update:
description: Project API key issued in Immutable Hub. DELETE /v1/audience/data requires a SECRET key;
sending a publishable key returns 401.
x-docs: https://docs.immutable.com/docs/guides/advanced-setup/api-keys
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.