Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 66 Next »

Our APIs and Callbacks allow you to integrate with our system in real time. We encourage customers to use real-time integration tools whenever possible. We also provide integration file tools you can use to integrate your CRM system if necessary.

API Table of Contents 

 

The REST API Tree URI Structure is as follows.

  • /companies [ G ]
    • /companies/:id [ G ]
      • /companies/:id/heartbeat [ G ]
      • /companies/:id/mobiledb
        • /companies/:id/mobiledb/persons [ S,P ]
          • /companies/:company_id/mobiledb/persons/:person_id  [ G,U ]
            • /companies/:company_id/mobiledb/persons/:person_id/subscriptions [ G ]
              • /companies/:company_id/mobiledb/persons/:person_id/subscriptions/:subscription_list_id  [ G, D, U? ]
        • /companies/:id/mobiledb/subscription_lists [ G ]
          • /companies/:id/mobiledb/subscription_lists/:id [ G ] 
        • /companies/:id/mobiledb/broadcasts [ S,P  ]
          • /companies/:id/mobiledb/broadcasts/:broadcast_id [ G,U,D? ]
      • /companies/:id/campaigns
        • /companies/:id/campaigns/acquisition [ G ] 
          • /companies/:id/campaigns/acquisition/:id [ G ]
            • /companies/:id/campaigns/acquisition/:id/participants [ S,P]
        • /companies/:id/campaigns/wallet [ G ] 
          • /companies/:id/campaigns/wallet/:id [ G ] 
            • /companies/:id/campaigns/wallet/:id/items [ G ] 
              • /companies/:id/campaigns/wallet/:id/items/:item_id [ GU ] 
            • /companies/:id/campaigns/wallet/:id/messages [ S,P ] 
              • /companies/:id/campaigns/wallet/:id/messages/:message_id [ G ] 
      • /companies/:id/incentives
        • /companies/:id/incentives/pools [ G ]
          • /companies/:id/incentives/pools/:pool_id [ G ]
            • /companies/:id/incentives/pools/:pool_id/issuances [ P ]
        • /companies/:id/incentives/codes
          • /companies/:id/incentives/codes/:code [ G ]
            • /companies/:id/incentives/codes/:code/issuances [ G ]
            • /companies/:id/incentives/codes/:code/redemptions [ G, P ]
      • /companies/:id/events [ P ] 
      • /companies/:id/config
        • /companies/:id/config/callbacks [ G,S,P ]
          • /companies/:id/config/callbacks/:callback_id [ G,D ]
  • /heartbeat [ G ]
  • No labels