Marketer API Concepts

The Marketer API lets a marketer control how features reach its distributors. A feature that has been made available on the platform is syndicated to a marketer; from there the marketer decides which of its distributors receive that feature, and each distributor in turn assigns the feature to its cards.

This guide explains the domain model behind the Marketer API. For the end‑to‑end picture of how a feature flows from the platform down to a card, see Feature Syndication.

Where the Marketer Fits

From a partner's perspective, the marketer is the top resource in the feature hierarchy:

Marketer
  └── Distributor
        └── Distributor Card

A marketer owns a set of features that have been syndicated to it and manages how they are distributed to its distributors.
A distributor is a downstream entity that receives features from the marketer.
A distributor card is the card program a distributor ultimately assigns the feature to.

Your access is scoped to the marketers and distributors your partner account is permissioned on.

Core Concepts

Features

A feature is a functional capability that can be attached to card programs (for example a loyalty or offers integration). The Marketer API exposes the features available to a marketer and lets you read a single feature's details.

Features available to a marketer come in two forms, distinguished by the distribution_mode on each row:

Syndicated — the feature was specifically syndicated to this marketer.
All‑users — the feature is open to everyone and needs no explicit syndication.

Feature Distribution

The distribution setting controls how far a feature reaches within a marketer:

All distributors — every distributor under the marketer receives the feature.
Selected distributors — only the distributors you explicitly syndicate the feature to receive it.

You read the current setting and update it through the feature's distribution endpoint.

Syndications

A syndication is the association between a feature and a distributor. Using the Marketer API you can:

List the distributors a feature is syndicated to (optionally narrowed to a single marketer).
Add one or more distributors to a feature in a single call.
Remove one or more distributors from a feature. Removals are always expressed as a list — removing a single distributor is simply a list of one.

Because a distributor already belongs to a marketer, the marketer is derived from each distributor and does not need to be supplied.

Downstream Views

Two read‑only views help you see the current state of distribution:

Features assigned to a distributor — every feature the marketer has assigned to a given distributor.
Distributor cards for a syndication — how a distributor has assigned the feature to its individual cards, including each card's bundle state.

Reference Data

The Marketer API provides scoped reference lists you use when building requests:

Marketers — the marketers the caller may act as or manage.
Distributors — the distributors in scope.
Distributor cards — the distributor cards in scope.

These are lookups only; they do not change any distribution or syndication state.

Key Patterns

UUID‑Based Identification

Features, marketers, distributors, and distributor cards are all identified by UUIDs. Use the uuid values returned in responses when referencing an entity.

Pagination

List endpoints are paginated through query parameters — see Pagination and Rate Limits.

Related Guides

Feature Syndication — The full feature lifecycle from platform to card
API Authentication and Credentials — How to authenticate API requests
API Scoping and Permissions — How data is scoped to your partner account
Marketer API Reference — Full endpoint documentation