Skip to main content

Base path

Most SDK endpoints are under: /sdk/v1 The compact campaign creator list is versioned separately at: GET /sdk/v2/campaigns/:campaignId/creators

Authentication (required on every request)

Send these headers on every request:
  • X-Application-Id: Your SDK application ID.
  • X-Api-Key: Your SDK API key secret.
If the application has an origin allowlist configured:
  • If the request includes an Origin header, it must match the allowlist.
  • If the request omits Origin (common server-to-server), allowlist checks are skipped.

Idempotency (required on payout writes)

These endpoints require X-Idempotency-Key:
  • POST /sdk/v1/payouts/trigger
  • POST /sdk/v1/payouts/trigger-bulk
  • POST /sdk/v1/payouts/confirm
  • POST /sdk/v1/payouts/confirm-bulk
  • POST /sdk/v1/payouts/cancel
  • POST /sdk/v1/campaign-creators/payouts/bulk
Idempotency keys are scoped per application and operation. Re-using the same key returns the previously stored response.

Limits and validation

  • Supported payout currencies: USD, CAD, GBP, EUR
  • Currency precision: money amounts must be positive and have max 2 decimals
  • Payout batches: up to 100 items per request
  • Campaign creator v1 reads: up to 100 creators per page
  • Campaign creator v2 reads: up to 500 creators per page or request
  • Eligibility score batches: up to 500 media items per request
  • Pending payout TTL: 7 days
  • Exports: require from and to and are capped at 10,000 rows

Response conventions

  • Most JSON endpoints return { success: boolean, ... }.
  • Balance check endpoints return { sufficient: boolean } (no success wrapper).
  • Export endpoints and invoice PDFs return file content (text/csv or application/pdf).

Pages

Campaign management

Minimal example (curl)