Actions (20)
Ambassadors · 6
- Add to ambassador balancePOST /api/v2/{username}/{token}/json/balance/add/
Adds to the running commission balance of an ambassador.
documented - Deduct from ambassador balancePOST /api/v2/{username}/{token}/json/balance/deduct/
Deducts from the running commission balance of an ambassador.
documented - Get ambassador detailsGET /api/v2/{username}/{token}/json/ambassador/get/
Retrieves contact details for a single contact by email address. If they do not exist as a contact, it can also automatically create the requested contact in an enrolled, prospect, banned, or unsubscribed status.
documented - Get ambassador statisticsGET /api/v2/{username}/{token}/json/ambassador/stats/
Retrieves statistics about a given ambassador including a summary and per-campaign report of their earned commissions, generated revenue, shares, share clicks and unique referrals as well as shares, share clicks, and unique referrals per social channel. Can automatically create the requested ambassador if they do not exist yet.
documented - List ambassadorsGET /api/v2/{username}/{token}/json/ambassador/all/
Retrieves a list of up to 100 ambassadors meeting the provided thresholds.
documented - Update ambassadorPOST /api/v2/{username}/{token}/json/ambassador/update/
Updates existing ambassador data.
documented
Commissions · 3
- Add commissionPOST /api/v2/{username}/{token}/json/commission/add/
Creates commission for given ambassador. Useful for commission events without referrers. For commissions with a referred party, use the event/record method.
documented - List commissionsPOST /api/v2/{username}/{token}/json/commission/all/
Retrieves up to 100 commissions meeting the provided thresholds.
documented - Update commissionPOST /api/v2/{username}/{token}/json/commission/update/
Updates the commission status. If a commission is pending "0", it can be changed to approved "1" or denied "2". Approved and denied commissions cannot be updated via API.
documented
Company · 3
- Get company SSO tokenGET /api/v2/{username}/{token}/json/company/token/
Returns one-time token which is required for Single Sign-on.
documented - Get company detailsGET /api/v2/{username}/{token}/json/company/get/
Retrieves details about your company and your active campaigns.
documented - Get company statisticsGET /api/v2/{username}/{token}/json/company/stats/
Retrieves high-level statistics about your company's referral program.
documented
Compliance · 2
- Export personal dataPOST /api/v2/{username}/{token}/json/compliance/export/
This endpoint allows for the export of all associated personal data from the system for the provided individual to assist with compliance requests such as the GDPR's right of access and/or right to data portability.
documented - Remove personal dataPOST /api/v2/{username}/{token}/json/compliance/remove/
This endpoint allows for the removal of all associated personal data from the system for the provided individual systematically on the Monday following the call. You must supply EITHER email or remote_customer_id but not both.
documented