Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.snappy.com/llms.txt

Use this file to discover all available pages before exploring further.

Before diving into individual API endpoints, it helps to understand how Snappy’s core objects relate to one another. Most API calls either create one of these objects or retrieve its current state — so a clear mental model will save you time when designing your integration.

​
Account Structure

​
Company

Your top-level account in Snappy. It holds your API keys, global configuration, and your recipient list. All accounts, campaigns, and gifts are ultimately scoped to a Company.

​
Account

An Account lives within a Company and lets you separate and organize gifting activity for different teams, departments, or budget owners — each with its own campaigns and billing method.
If your organization has multiple departments sending gifts independently, each should operate through its own Account.
→ See the full object schema in the API Reference

​
Billing Method

A Billing Method is the financial funding source used to pay for gifts and associated fees. It must be specified when creating a campaign and it is verified when sending a gift and must have sufficient funds or credit at the time of the request — otherwise the gift will not be processed. Billing Methods are set at the Account level. One Billing Method per Account can be set as the default. This default is applied automatically to any Campaign created via the API. Campaigns created through the Dashboard allow you to select a Billing Method explicitly at the time of creation. Snappy supports several billing method types. Note that credit card (EXP) cannot currently be used to send gifts via the API.
Billing Methods can currently be defined and managed through the Snappy Dashboard
→ See the full object schema in the API Reference

​
The Gift Pipeline

​
Campaign

A Campaign is the primary organizational object for configuring and sending gifts. It represents a single gifting activity or occasion and acts as a template for all settings that apply to it — including the selected Collection or Product, budget, branding, and notification messages. Think of it as: a reusable send configuration. Campaigns can be created via the Dashboard or directly through the API. When created via the API, the Account’s default Billing Method is applied automatically.
Every gift must be associated with a Campaign. You cannot send a gift without one.
→ See the full object schema in the API Reference

​
Gift

A Gift is the core transactional object in Snappy. It represents the entire gifting experience for a single recipient within a Campaign — from creation through to final delivery. The gift life cycle is different for each integration model. For ‘Triggered Gifting’ it will include notifying the recipient and receiving their selection and will include the following stages:
StageWhat happens
CreationGift is initiated and linked to a recipient and Campaign
NotificationRecipient is notified via email or other channels
SelectionRecipient chooses their item and variation, and enters their shipping address
Order GenerationAn Order is created based on the selected variant and shipping address
DeliveryThe physical product is shipped and tracked to completion
But for the ‘Direct Fulfillment’ model it will only include the following stages:
StageWhat happens
Creation + Order GenerationGift is initiated and linked to a recipient and Campaign and an Order is created based on the selected variant and shipping address
DeliveryThe physical product is shipped and tracked to completion
Use Webhooks to track Gift status changes in real time rather than polling.
→ See the full object schema in the API Reference

​
Order

An Order is a sub-entity of the Gift entity. It is created either:
  • Automatically by Snappy once a recipient selects their item and variant and enter their shipping address in the Snappy Recipient Experience (Triggered Gifting model).
  • Directly by your system by passing the selected variant ID and shipping address to Snappy (Direct Fulfillment model).
The Order represents the physical fulfillment event — the point at which a gift becomes a shipment.
Use Webhooks to track fulfillment and delivery status in real time rather than polling.
→ See the full object schema in the API Reference

​
Recipient

A Recipient is a person in your Snappy contact list. Once created, they can be referenced across multiple gift sends without re-submitting their details each time.
For one-off sends, you can pass contact details inline when creating a Gift. However, for recurring use cases — employee anniversaries, loyalty rewards — managing Recipients via the API keeps your integration clean and avoids duplicate contacts.
→ See the full object schema in the API Reference

​
The Gift Catalog

Snappy offers two gift types, and understanding the distinction is important for how you configure your Campaigns:

​
Collection

A Collection is a curated catalog of items tailored to a specific theme, budget range, and audience (e.g., “Wellness Gifts Under $50”). Assign a Collection to a Campaign if you want the recipient to select their preferred item. → See the full object schema in the API Reference

​
Product

A Product is a single specific item — physical swag, a digital gift, an experience, and more. Assign a specific product to a Campaign when you have a specific item in mind. Notice that if that product has variants the recipient will need to select the specific one (i.e size, color etc). → See the full object schema in the API Reference

​
Product Variant

Many Products come in multiple variations — for example, a hoodie in different sizes and colors. Each variation is represented as a distinct Variant.
When placing an Order you must specify the Variant ID and not the Product ID.
→ See the full object schema in the API Reference
Where do Collections and Products come from?Both can come from Snappy’s curated catalog, but you also have options to build your own:
  • Collections can be created and customized directly in the Snappy Dashboard — letting you curate your own themed gift sets from the catalog.
  • Products — if you’re sending branded swag, Snappy supports custom-designed items. These can be set up through the Dashboard and will then appear as Products available to your Campaigns.
Contact your Snappy account manager to get started with custom swag.

​
Gift Customization

Gift Customization is not a standalone entity you create independently — it is a configuration layer that controls how a gift looks and behaves for the recipient. It is unique in that it can be defined at multiple levels of your account hierarchy and is inherited downward, with each level able to override the one above it.

​
The Three Configuration Areas

​
Gift Properties

The core characteristics of the gift: type (Collection or specific Product), budget, expiration period, and similar settings.

​
Notification Policy

Controls how and when recipients are notified — through which channels, with what content, and at what timing.

​
Recipient Experience

Defines the interactive journey recipients go through when claiming their gift: the unwrapping animation, greeting message, and address collection flow.
You can explore recipient experience options and generate an API-ready payload at https://login.snappy.com/api/gift-customization.

​
Inheritance & Overrides

Gift Customization follows a top-down inheritance model. Defaults set at a higher level flow down automatically, but can be overridden at any level below: 
Company defaults → Account defaults → Campaign settings → Individual Gift
Example: Your Account has a default gift expiration of 30 days. You create a Campaign that overrides this to 14 days. When creating an individual Gift, you can override it again — for example, to give a high-value recipient more time: 
{
  "campaignId": "cmp_12345",
  "recipients": [
    {
      "firstname": "Jane",
      "lastname": "Doe",
      "email": "jane@example.com",
      "key": "jane-vip-2025"
    }
  ],
  "customization": {
    "giftProperties": {
      "expiration": {
        "type": "daysFromSend",
        "numberOfDays": 60
      }
    }
  }
}
In this example, even though the Campaign default is 14 days, this specific Gift will expire after 60 days. The Campaign default is not affected — all other gifts created under this Campaign will still use the 14-day expiration.
Overrides at the Gift level apply only to that specific Gift. They do not modify the Campaign, Account, or Company defaults.
Via the API, Gift Customization can only be set at the Campaign level and below. Company and Account level defaults must be configured through the Snappy Dashboard.

​
Entity Relationship Diagram

A Campaign is configured with either a Collection or a specific Product — not both.
Gift Customization follows a top-down inheritance model — defaults defined at the Company level flow down through Account and Campaign to the individual Gift, with each level able to override the one above it.

​
Quick Reference

EntityLives insideCreated viaNotes
Company—Snappy onboardingRoot of everything
AccountCompanyDashboard or APIOrganizes campaigns by team or department
Billing MethodAccountDashboardMust be funded; debited on gift creation
CampaignAccountDashboard or APIRequired to send any Gift. When created via API, inherits the Account’s default Billing Method.
CollectionAccountSnappy catalog or DashboardRecipient chooses from it
Product / VariantAccountSnappy catalog or DashboardVariant required for direct orders
RecipientCompanyAPI or DashboardCan be passed inline for one-off sends
GiftCampaignAPI or DashboardOne per recipient per send
OrderGiftAutomatically or direct API callCreated on item selection or direct fulfillment
Gift CustomizationCompany / Account / Campaign / GiftDashboard or API (Campaign & Gift)Inherited and overridable at each level
Last modified on April 30, 2026