API Reference

Contents:

• Introduction
  • Base URL
  • Authentication
  • Response Format
  • Date Format
  • Errors
• Referral Program via API
  • Initial Origin
  • Displaying and Sharing the Offer
  • Claiming an Offer
  • Submit Origin data to Talkable to generate the Referral
• Campaigns
  • Example
• Visitors
  • Example
    • Create a visitor
• Origins
  • Example
    • Create a purchase
    • Create an event
    • Create an affiliate member and target a campaign
    • With sharing links
• Refunds
  • Example
    • Mark Purchase as Refunded
• People
  • Example
    • Find a person by email
    • Get Friends referred by Advocate
    • Get rewards received by person
    • Get shares made by person
    • Update person’s username
    • Unsubscribe a person from receiving emails
    • Anonymize a person
    • Get personal information about a person
• Advocate Offers
  • Example
    • With sharing links
• Shares
  • Example
    • Create a Facebook share
    • Create an Email share
• Referrals
  • Example
    • Approve a Referral
• Rewards
  • Example
• Coupons
  • Example
    • Find a coupon by code
    • Check if a coupon belongs to a person
• Metrics
  • Example
    • Offers metric
    • Revenue percentage metric with precision
    • Average order value metric
    • Detalized metric
• Traffic sources
  • Example
• Loyalty members
  • Example
    • Find a loyalty member by email
    • Update loyalty member’s custom properties
    • Adjust loyalty member’s points balance