No API documented yet. Know where the docs live? Propose the links above.
Actions (39)
Referrals · 7
- Create referralPOST /api/referrals
Adds a referral to a referral program based on a referral code from a member.
documented - Delete referralDELETE /api/referral/remove
Deletes referrals in a referral program.
documented - Get referralGET /api/referral/single
Get a single referral by email, referralId, or externalId.
documented - List referralsGET /api/referrals
Get a list of referrals ordered by create date. Can filter by program.
documented - Remove referralPOST /api/referral/remove
Deletes referrals in a referral program.
documented - Update referralPOST /api/referral/update
Updates referrals in a referral program using a query object to identify referrals and a referral object for updates.
documented - Update referral statusPOST /api/referrals/status
Updates the status of a referral.
documented
Rewards · 6
- Bulk remove rewardsPOST /api/rewards/remove
Deletes rewards from members or referrals in a program (bulk operation).
documented - Create rewardPOST /api/rewards
Creates new rewards for members and referrals in a program.
documented - Issue rewardPOST /api/rewards/issue
Issues a specific reward.
documented - List rewardsGET /api/rewards
Get a list of rewards ordered by create date.
documented - Remove rewardDELETE /api/rewards/remove
Deletes a reward from a member or referral of a program.
documented - Update rewardsPOST /api/rewards/update
Updates rewards within a referral program.
documented
Members · 5
- Create memberPOST /api/members
Creates a new member and adds it to a referral program.
documented - Delete membersDELETE /api/members/remove
Deletes members of a referral program (alternative delete method).
documented - List membersGET /api/members
Get a list of members ordered by create date. Can filter by program; supports offset and count.
documented - Remove membersPOST /api/members/remove
Deletes members of a referral program based on a query object.
documented - Update membersPOST /api/members/update
Updates members of a referral program using a query object to identify members and a member object for updates.
documented
Email · 4
- Delete unsubscribe entryDELETE /api/email/removeunsubscribe
Delete an unsubscribe entry for an email address.
documented - Get unsubscribed emailsGET /api/email/getunsubscribed
Get all unsubscribed emails or by specific address.
documented - Remove email from unsubscribe listPOST /api/email/removeunsubscribe
Remove an email address from the unsubscribe list.
documented - Unsubscribe emailPOST /api/email/unsubscribe
Unsubscribe an email address.
documented
Hooks · 4
- Create hookPOST /api/hooks
Specify a URL to receive webhook POSTs when events occur.
documented - Get hook historyGET /api/hooks/history/{eventName}
Get historical webhook events for a given event name.
documented - Get hook history (v2)GET /api/v2/hooks/history/{eventName}
Get historical webhook events (v2) for a given event name.
documented - Remove hookDELETE /api/hooks
Unsubscribe from a webhook event.
documented
Payouts · 4
- Create payout transactionsPOST /api/payouts/transactions
Payout pending rewards and return issued reward transactions.
documented - Get payoutGET /api/payouts/{id}
Get a payout by ID.
documented - List payout transactionsGET /api/payouts/transactions
Transactions representing payouts transferred to participants; can be filtered.
documented - List pending payoutsGET /api/payouts/pending
Payouts yet to be transferred to a member; can be filtered by member.
documented