Partner APIs

MailAdx provides programmatic control over inventory configuration, deal management, and reporting via the Partner APIs — designed for networks and publishers running automated operations.

Authentication

All Partner API requests use Bearer token authentication with an account-scoped API key. Generate keys at Dashboard → Settings → API Keys. Keys inherit the permissions of the role they are assigned to — use Publisher Manager scope for inventory APIs and Read Only scope for reporting APIs to minimise blast radius.

Inventory management API

Create, update, and delete ad placements programmatically — useful for networks onboarding new publishers via an automated flow. Key endpoints:

  • GET /v1/placements — list all placements
  • POST /v1/placements — create a placement
  • PATCH /v1/placements/{id} — update placement config
  • DELETE /v1/placements/{id} — deactivate a placement

Deal management API

Automate deal creation and management for high-volume direct sales operations:

  • POST /v1/deals — create a direct-sold deal
  • GET /v1/deals/{id} — get deal status and delivery
  • PATCH /v1/deals/{id} — update deal terms

Publisher management API (Networks)

Network accounts can manage publisher sub-accounts programmatically:

  • POST /v1/publishers — create a publisher sub-account
  • GET /v1/publishers — list all publishers in the network
  • POST /v1/publishers/{id}/invite — send portal invitation to publisher

Rate limits and pagination

Partner API endpoints have a rate limit of 120 requests per minute per account. List endpoints return up to 100 items per page by default; use the cursor parameter for pagination.

Webhook events

Subscribe to account events via webhook to build reactive integrations. Available events: placement.created, deal.status_changed, publisher.onboarded, billing.invoice_generated. Configure webhooks at Dashboard → Settings → Webhooks.