Skip to main content
Access to individual endpoints can be restricted per account. If a request to this endpoint returns 403 with error code endpoint_not_enabled and you expect to have access, contact your account representative.
The Pools API lets you define a reusable set of networks and merchants once, then reference it by ID across search endpoints. Instead of passing the same network_ids and merchant_ids on every request, you attach a pool_id and the API resolves the filters automatically.

What is a pool?

A pool is a named, reusable configuration for one of your sites, apps or campaigns. It bundles three things: which networks and merchants you want to surface, which network credentials your links are built with, and how outclick links choose a provider. Create one pool per site or brand, then pass its pool_id instead of repeating filter lists on every request. Example: a coupon site and a price-comparison app on the same account can each have their own pool. They get different merchant lists and different tracking credentials, with no code changes between requests.

How pools work

A pool stores:
  • Networks — affiliate networks to include
  • Merchants — merchants to include in results
When you pass pool_id to a supported search endpoint, the pool’s networks and merchants are combined with any explicitly passed filter values — not replaced.
Pools are team-scoped. Passing a pool_id that belongs to a different team returns a 422 error.
Pass pool_id as a top-level parameter to any of these endpoints:
The pool_-prefixed object_id form and the bare ULID are both accepted. Only one pool_id may be passed per request. Returns 422 if the pool does not exist or belongs to another team, and 404 if the pool has been deleted.

Using a pool with GET /v1/merchants

pool_id behaves differently here than on products/omni/promotions — it’s a hard scope rather than a filter merge, and it also decides whose credentials build providers[] links. Requires extended=1.
cURL
Running more than one pool — separate credentials per site or brand, say? Pass the pool_id that matches the request; a Source configured on one pool never applies to a different pool’s request. This is not provider isolation, though — for a provider the pool owns no credential for, resolution falls back to your account-level credential, so links can still come back with a different campaign than a pool that owns its own. See Monetizing with the Merchants API for a full worked example.

Available endpoints