Introduction
Versioning
Quick Start
Common API Conventions
Terminology
Access and Authentication
Requests
Standard Pagination
Cursor Pagination
Rate Limits
Version 1 API Conventions
Requests
Response Formats
Rate limit response
Compression
Version 2 API Conventions
Requests
Responses
Errors
Date Time
Version 3 API Conventions
Requests
Responses
Errors
Date Time
Networks and Brands Management (v1)
Networks
get
List Networks
Network Partners
post
Create network partner
post
Create network partner with user account
get
List all Partners on the Network
post
Update Partner's Network status
Network Terms and Conditions
get
List all terms and conditions for a network
Brands
get
List all Brands
post
Create Brand
get
Retrieve a Brand
post
Update a Brand
Campaign Management (v1)
Campaigns
get
List all Campaigns
post
Create a Campaign
get
Retrieve a Campaign
post
Delete a Campaign
put
Update a Campaign
get
List all Brand Campaigns
Participating Partners
get
List all Participating Partners
post
Update a Partner Participation on a Campaign
get
Retrieve a Participating Partner
Partner Groups
get
List all Partner (Commission) Groups for a given campaign
get
Retrieve a Partner (Commission) Group
post
Create Partner (Commission) Groups
put
Update Partner (Commission) Groups
Custom Terms and Conditions
post
Create Custom Terms and Conditions
get
List All Custom Terms and Conditions for given campaign
get
List Partner's Terms and Conditions for a capaign.
del
Delete specific Custom Terms and Conditions
post
Associate Custom Terms and Conditions with Partners
del
Remove associations between the Custom Terms and Conditions and Partners
Voucher Codes
get
List all Campaign Voucher Codes
post
Create Voucher Codes
put
Update Voucher Codes
get
Retrieve a Voucher Code
Creatives
get
List all Creatives for a Campaign
post
Create Campaign Creatives
put
Update Campaign Creatives
get
List all Creative Tags for Campaign
post
Create Campaign Creative Tags
put
Update Campaign Creative Tags
del
Delete Campaign Creative Tags
get
List all Creatives for a Campaign by Tags
Product Feeds
get
List all Product Feeds for a Campaign
post
Create a Product Feed
put
Update a Product Feed for a Campaign
Deals
get
List all Campaign Deals
post
Create a Campaign Deal
get
Retrieve a Campaign Deal
patch
Update a Campaign Deal
del
Delete a Campaign
Meta Attributes
get
List all Meta attributes for Campaign
Payments (v1)
Campaign Transaction Queries
get
List all Transaction Queries for a Campaign
post
Approve a Transaction Query
post
Pend a Transaction Query
post
Reject a Transaction Query
post
Bulk processing of Transaction Queries
Transaction Query Reasons
get
List Transaction Query Reasons for a Campaign
post
Create a Transaction Query Reason for a Campaign
post
Delete a Transaction Query Reason for a Campaign
Invoices
get
List all Invoices
get
Retrieve an Invoice
Commissions (v2)
Commissions
get
List Commissions
post
Create Commission
get
Get Commission
patch
Update Commission
post
Migrate Commission
post
Retire Commission
Promotional Commissions
get
List Promotional Commissions
post
Create Promotional Commission
get
Get Promotional Commission
del
Delete Promotional Commission
patch
Modify Promotional Commission
post
Retire Promotional Commission
Tiers
get
List Commission Tiers
post
Create Commission Tier
del
Delete Commission Tier
patch
Modify Commission Tier
Partner Commissions
get
Get Partner Default Commissions
get
List Partner Commissions For Specific Campaign
get
List Partner Voucher Commissions For Specific Campaign
get
List Partner Promotional Commissions For Specific Campaign
get
List Partner Tiered Commissions For Specific Campaign
get
List Active Partner Commissions
Meta Fields
get
List Campaign Meta Fields
get
List Tier Meta Fields
Partner management (v2)
Campaign Requests and Invites
get
List Partner Campaign Requests and Invites
get
List Campaign Requests and Invites Filters.
get
Retrieve Partner Campaign Invites and Requests Details.
post
Accept Campaign Requests
post
Decline Campaign Requests
Discovery Settings
get
List discovery settings for brands
put
Update Brand Marketplace settings
Communications tool (v2)
Communications
get
List communications
post
Creates a new draft communication
get
Retrieves a single communication
put
Updates a draft communication
del
Deletes an existing draft communication
get
Returns the content of a communication
put
Updates the content of a communication
post
Sends a communication preview
post
Sends or schedules a draft communication
del
Cancels a scheduled communication
get
Communications summary report
Platform Communications
get
Get platform events list
post
Create platform communication
get
Get platform communications list
del
Deletes an existing platform communication
get
Returns the content of a platform communication
post
Validate content
Placeholders
get
Placeholders list
Tracking and Conversions (v3)
Campaign Conversions
post
Bulk update of conversions
Background Jobs (v3)
Jobs
get
Get a list of jobs for the user
get
Get a single job
get
Get tasks for a job
get
Get detailed task information
Reporting (v1)
Brand Overview (Obsolete)
get
Retrieve a Campaign Overview Report for a date range (Obsolete)
get
Retrieve a Campaign Overview Report for a specified period (Obsolete)
get
Retrieve a Campaign Overview Report for multiple date ranges (Obsolete)
get
Retrieve a Network Overview Report (Obsolete)
Brand Conversions
get
Retrieve a Brand Conversions Report
Brand Clicks
get
Retrieve a Brand Clicks Report
Exports
get
Export a Clicks Report
