Customers can automatically send gifts using our Trigger Campaign API.
In order to use our Trigger Campaign API to send gifts:
- Provide an API token for each request. Review how to authenticate here.
- Make sure you the correct campaigns setup to send gifts. Review how to create campaigns here. Note that we only accept campaigns, and not triggered campaigns in the Trigger Campaign API.
- Review the parameters required to send gifts. Refer to our Trigger Campaign API documentation here.
How do we decide what Payment Wallet to use when sending gifts?
We will use a combination of the Payment Wallet Team, Payment Currency and the Team Name to select the Payment Wallet.
Payment Currency | Payment Wallet Type | Team Name | Payment Wallet |
Empty | Empty or User | Empty | User wallet in the campaign's currency |
Empty | Team | Empty | Default team wallet in the campaign's currency |
Empty | Team | Sender's team | Team wallet of the team in the campaign's currency |
Populated with a valid currency | Empty or User | Any | User wallet in the specified currency |
Populated with a valid currency | Team | Empty | Default team wallet in the specified currency |
Populated with a valid currency | Team | Sender's team | Team wallet of the team in the specified currency |
Other conditions:
-
If the Payment Currency is empty, we will use the campaign's currency to look for the wallet.
- If the Payment Wallet Type is empty, we will use "User" as the default and look for a user wallet.
- If the Team is empty or it does not exist, we will use the "Default team" to look for the team wallet.
- If the Payment Wallet does not exist:
- If it's a user wallet, we will automatically create the user wallet
- If it's a team wallet and the sender is part of the team, we will automatically create the team wallet
- If it's a team wallet and the sender is NOT part of the team, we will use the user’s wallet with the specified currency
Examples:
Example 1:
- Payment wallet type = User
- Payment Currency = GBP
- Sender team = empty
- The payment wallet will be the Sending User's "User Wallet GBP"
Example 2:
- Payment wallet type = Team
- Payment Currency = GBP
- Sender team = Account Managers UK
- The payment wallet will be the Sending User's "Account Managers UK Team Wallet GBP"
We offer a number of other API endpoints that you can use, such as listing campaigns, sends, contacts or transactions. Please review our API documentation for more details.
If you have any questions, please contact support@reachdesk.com.
Comments
0 comments
Please sign in to leave a comment.