Use the Reachdesk Trigger Campaign API to automatically send gifts from your own systems or workflows. 

Before you start

To send gifts with the Trigger Campaign API, you need to complete all of the following:

• Provide an API token with each request: Admins can generate and manage these in Reachdesk via Organization > Settings > API Tokens.

• Use the correct campaign type: You must send gifts using a manual campaign. The Trigger Campaign API does not support campaigns created as automated campaigns.

• Review the required request parameters: Check the Trigger Campaign API documentation to confirm which fields are required for your send.

How Reachdesk selects the payment wallet

Reachdesk selects the payment wallet using a combination of the following parameters:

1. Payment Wallet Type (User or Team)

2. Payment Currency

3. Team Name

Payment wallet selection rules

Additional payment wallet conditions

• If Payment Currency is empty: Reachdesk uses the campaign's currency to find the payment wallet.

• If Payment Wallet Type is empty: Reachdesk defaults to User and looks for a user wallet.

• If Team Name is empty or does not exist, Reachdesk falls back to the sender’s default team and looks for that team wallet.

• If the payment wallet does not exist: Reachdesk handles wallet creation and fallback as follows:

  • If the required wallet is a User wallet, Reachdesk automatically creates it.

  • If the required wallet is a Team wallet and the sender is part of that team, Reachdesk automatically creates it.

  • If the required wallet is a Team wallet and the sender is not part of that team, Reachdesk falls back to the sender’s User wallet in the specified currency.

Examples

Example 1: User wallet in a specified currency

• Payment Wallet Type: User

• Payment Currency: GBP

• Sender team: Empty

• Result: Reachdesk uses the sending user's User Wallet GBP.

Example 2: Team wallet in a specified currency

• Payment Wallet Type: Team

• Payment Currency: GBP

• Sender team: Account Managers UK

• Result: Reachdesk uses the sending user's Account Managers UK Team Wallet GBP.

Example 3: Team wallet when Team Name is empty

• Payment Wallet Type: Team
• Payment Currency: GBP
• Team Name: Empty
• Result: Reachdesk uses the sender’s default team wallet in GBP.

Using custom attributes to customize gift notes, gift options and gift emails

You can add custom attributes that can be used when setting up campaigns, which will work for any gift note, gift email and gift option field that is a text field.

Simply define the name and the value of your custom attributes in the request. 

Note: You must use an underscore instead of spaces in the name for this to work (e.g. custom_gift_note)

Edit a campaign, and use the custom attribute as a variable by inserting it in double curly braces, (i.e. {{custom_gift_note}}). For e.g. if you want to customize the gift options and gift note for a brandable product, you can insert them as variables on the campaign's Gift details below.

Other available API endpoints

Reachdesk also provides other API endpoints, including:

• Listing campaigns

• Listing Engages (send records)

• Listing contacts

• Listing transactions

See the Reachdesk API documentation for full details.

Frequently Asked Questions

Can I use an automated campaign with the Trigger Campaign API? 

No. The Trigger Campaign API only accepts manual campaigns. It does not accept automated campaigns.

What happens if I do not provide a payment currency? 

If Payment Currency is empty, Reachdesk uses the campaign's currency to find the wallet.

What happens if the required wallet does not already exist?

• If the wallet is a User wallet, Reachdesk creates it automatically.

• If the wallet is a Team wallet and the sender belongs to that team, Reachdesk creates it automatically.

• If the wallet is a Team wallet and the sender does not belong to that team, Reachdesk falls back to the sender’s User wallet in the specified currency.

What happens if Team Name is empty or does not exist?

If payment_wallet_type is Team and team_name is empty or does not exist, Reachdesk falls back to the sender’s default team wallet.

Where can I get further assistance with this? 

If you have any questions, please contact support@reachdesk.com.