Affiliate API's
N
Nathan Shaw
Affiliates:
• GET /v1/affiliates - List all affiliates
• POST /v1/affiliates - Create a new affiliate
• GET /v1/affiliates/{id} - Retrieve affiliate details
• PUT /v1/affiliates/{id} - Update affiliate metadata & commission model
• DELETE /v1/affiliates/{id} - Deactivate/remove affiliate
Referral Links:
• POST /v1/affiliates/{id}/links - Generate a new referral link
• GET /v1/affiliates/{id}/links - List all links for an affiliate
• DELETE /v1/links/{linkId} - Revoke a referral link
Event Tracking:
• POST /v1/events/click - Record click on referral link
• POST /v1/events/lead - Record a New Lead via affiliate
• POST /v1/events/appointment - Record scheduled appointment via affiliate
• POST /v1/events/conversion - Record opportunity or sale conversion
• POST /v1/events/purchase - (alias) Record purchase
Workflow Hooks:
• POST /v1/webhooks - Register webhook for any Affiliate.* event
• DELETE /v1/webhooks/{id} - Unsubscribe
Contact Integration:
• POST /v1/contacts/{contactId}/affiliate - Link an existing contact to an affiliate manually
• GET /v1/contacts/{contactId}/affiliate - Retrieve affiliate attribution on a contact
Commissions & Payouts:
• GET /v1/affiliates/{id}/commissions - Calculate commissions (flat, %, tiered, multi-level)
• POST /v1/affiliates/{id}/payouts - Trigger a payout
• GET /v1/affiliates/{id}/payouts - List past payouts
Log In