Concepts
This API surface is for integration partners building on top of the Rokt network. Rokt ecommerce partners integrating placements on their own checkout should use the Rokt Ecommerce developer docs instead.
The Partnerships API surface is small, but a handful of concepts shape how every endpoint behaves. Read these once before you wire up your integration; they're the contracts that govern retries, replacement vs patch semantics, async writes, taxonomy translation, and how surfaces map to SDK calls on the merchant's page.
Recommended reading orderDirect link to Recommended reading order
If you're integrating end-to-end, walk these in order. Earlier concepts are prerequisites for later ones; for example, real controls writes use an idempotency key and return an operation ID for polling, while dry runs bypass both.
Your platform is the manager; the merchants you onboard are managed accounts. Read when you're about to make your first authenticated call.
Real managed-account writes require Idempotency-Key. Dry runs skip the key check and cache. Registration uses its merchant identifier instead.
Verticals merge onto stored policy; domains and status replace in full. Read before your first controls update.
Supported operations accept dry_run=true to validate without saving changes. Read the response contract for each operation before building a validation flow.
Real managed-account writes return X-Operation-Id; dry runs do not. Use it to recover the result of a write you lost the response to. Read once you understand idempotency.
Block verticals in your partner taxonomy; Rokt translates server-side. Read when you start building marketplace controls.
How surfaces (confirmation, tracking, returns) map to page_identifiers and how the layout customization PATCH works. Read before SDK integration.
Network opt-out, network data deletion, and managed-account data deletion. Read when adding privacy request flows.