# Snappy API Docs

> Developer documentation for the Snappy API — authenticate, send gifts at scale, manage campaigns, and integrate webhooks into your platform.

## Docs

- [Accounts API Overview](https://docs.snappy.com/accounts-overview.md): Manage accounts, sub-accounts, and budget hierarchy. Endpoints, fields, and common patterns for organizing campaigns by team or initiative.
- [Create account](https://docs.snappy.com/api-reference/accounts/create-account.md): Use this API to create a new account.
- [Get account by ID](https://docs.snappy.com/api-reference/accounts/get-account-by-id.md): Use this API to retrieve the details of a specific account.
- [Get accounts](https://docs.snappy.com/api-reference/accounts/get-accounts.md): Use this API to search for and retrieve a list of accounts based on your specified criteria.
- [Create API key](https://docs.snappy.com/api-reference/authentication/create-api-key.md): Create a new API key for the company. The API key is used to authenticate the company's requests to the Snappy API.
- [Delete API key](https://docs.snappy.com/api-reference/authentication/delete-api-key.md): Delete an API key by id. The API key is used to authenticate the company's requests to the Snappy API.
- [Get API keys](https://docs.snappy.com/api-reference/authentication/get-api-keys.md): Get all the API keys of the company. The API keys are used to authenticate the company's requests to the Snappy API.
- [Create campaign](https://docs.snappy.com/api-reference/campaigns/create-campaign.md): Use this API to create a new campaign.
- [Get campaign by ID](https://docs.snappy.com/api-reference/campaigns/get-campaign-by-id.md): Use this API to retrieve a specific campaign. This can be used for reviewing campaign settings and configuration before sending gifts.
- [Get campaigns](https://docs.snappy.com/api-reference/campaigns/get-campaigns.md): Use this API to search for and retrieve a list of campaigns based on your specified criteria.
- [Get estimated cost for campaign](https://docs.snappy.com/api-reference/campaigns/get-estimated-cost-for-campaign.md): Use this API to get the estimated cost of a campaign. The estimated cost is calculated based on the budget, number of recipients, taxes and fees.
- [Update campaign by ID](https://docs.snappy.com/api-reference/campaigns/update-campaign-by-id.md): Use this API to update an existing campaign's configuration, including name, status, and customization settings.
- [Get collection product](https://docs.snappy.com/api-reference/collections/get-collection-product.md): Use this API to retrieve a specific product from a specific collection.
- [Get collection products](https://docs.snappy.com/api-reference/collections/get-collection-products.md): Use this endpoint to retrieve a list of products available within a **specific gift collection**, which can be filtered by: - Budget range - Supported countries
- [Get collection products count](https://docs.snappy.com/api-reference/collections/get-collection-products-count.md): Use this endpoint to retrieve the number of products available in a specific gift collection.
- [Get collections](https://docs.snappy.com/api-reference/collections/get-collections.md): Use this API to search for and retrieve a list of available gift collections based on your specified criteria.
- [Get collections budgets](https://docs.snappy.com/api-reference/collections/get-collections-budgets.md): Budget ranges determine the price points that recipients can choose from when selecting gifts.
- [Create demo gift](https://docs.snappy.com/api-reference/gifts/create-demo-gift.md): This endpoint creates a **demo gift**, which is a special, non-claimable gift that allows you to preview and test the full recipient experience without incurring any costs.
- [Create gifts](https://docs.snappy.com/api-reference/gifts/create-gifts.md): Use this endpoint to create one or more gifts within a Campaign and initiate the Triggered Gifting flow. Snappy will notify recipients based on the Campaign's Notification Policy.
- [Create gifts by webhook](https://docs.snappy.com/api-reference/gifts/create-gifts-by-webhook.md): This endpoint provides a simplified, webhook-style method for creating and sending gifts. It's designed for easy integration with third-party systems like CRMs and marketing automation platforms, allowing you to trigger gift sends based on external events.
- [Expire a gift](https://docs.snappy.com/api-reference/gifts/expire-a-gift.md): Use this endpoint to expire a gift that has not yet been claimed by the recipient. This operation prevents the recipient from selecting a product and generating an order.
- [Get gift by ID](https://docs.snappy.com/api-reference/gifts/get-gift-by-id.md): Use this endpoint to retrieve a specific gift by its ID. It is typically used to check the current delivery status, review recipient and campaign context, or retrieve the final gift cost for reporting and reconciliation.
- [Get gifts](https://docs.snappy.com/api-reference/gifts/get-gifts.md): Use this API to search for and retrieve a list of gifts based on your specified criteria.
- [Update gift by ID](https://docs.snappy.com/api-reference/gifts/update-gift-by-id.md): Use this API to update the details of a specific gift that hasn't been claimed yet.
- [Autocomplete order address](https://docs.snappy.com/api-reference/orders/autocomplete-order-address.md): Autocomplete a partial shipping address. Returns address suggestions based on the provided input to help recipients fill in their delivery details accurately.
- [Cancel an order](https://docs.snappy.com/api-reference/orders/cancel-an-order.md): Use this endpoint to cancel an order that has not yet been processed or shipped. A successful request returns the cancelled order ID and its updated status.
- [Claim a gift](https://docs.snappy.com/api-reference/orders/claim-a-gift.md): Use this endpoint to programmatically claim an existing gift on behalf of a recipient by providing the selected variant and shipping address. Use this when your system needs to place an order without recipient interaction — for example, automatically ordering a default product for gifts that remain…
- [Validate order address](https://docs.snappy.com/api-reference/orders/validate-order-address.md): Validate a shipping address before placing an order. This endpoint checks that the provided address is valid and deliverable.
- [Get product tags](https://docs.snappy.com/api-reference/products-&-variants/get-product-tags.md): Retrieve a list of product tags. This endpoint allows you to: - Get all available product tags (paginated) - Search for tags by name using the title parameter
- [Get products](https://docs.snappy.com/api-reference/products-&-variants/get-products.md): Use this API to search for and retrieve a list of available products based on your specified criteria.
- [Get variant by ID](https://docs.snappy.com/api-reference/products-&-variants/get-variant-by-id.md): Use this API to retrieve a specific product variant.
- [Get variants by product ID](https://docs.snappy.com/api-reference/products-&-variants/get-variants-by-product-id.md): Use this API to search for and retrieve a list of variations of a specific product based on your specified criteria.
- [Create recipient](https://docs.snappy.com/api-reference/recipients/create-recipient.md): Use this API to create a new recipient.
- [Delete recipient by ID](https://docs.snappy.com/api-reference/recipients/delete-recipient-by-id.md): Use this API to delete a specific recipient.
- [Get recipient by ID](https://docs.snappy.com/api-reference/recipients/get-recipient-by-id.md): Use this API to retrieve the details of a specific recipient.
- [Get recipients](https://docs.snappy.com/api-reference/recipients/get-recipients.md): Use this API to search for and retrieve a list of recipients based on your specified criteria.
- [Update recipient](https://docs.snappy.com/api-reference/recipients/update-recipient.md): Use this API to update the details of a specific recipient.
- [Snappy API Authentication: API Keys, Scopes & mTLS](https://docs.snappy.com/authentication-and-security.md): Generate and rotate scoped API keys, manage granular permissions, and configure Mutual TLS for enterprise integrations.
- [Before You Begin: Prerequisites for the Snappy API](https://docs.snappy.com/before-you-begin.md): Account access, API key generation, Testing vs. Production environments, and supported regions — everything you need before integrating Snappy.
- [Campaigns API Overview](https://docs.snappy.com/campaigns-overview.md): Plan, schedule, and report on gifting campaigns. Estimate cost, track delivery, and trigger from CRM or HR events.
- [Changelog](https://docs.snappy.com/changelog.md): Recent updates, new features, and breaking changes. Track API versions and migrate between releases.
- [Collections API: Curated Gift Catalogs](https://docs.snappy.com/collections-overview.md): Bundle products into curated collections by budget, theme, or audience, and serve them through the Snappy API.
- [Direct Fulfillment (Embedded Marketplace)](https://docs.snappy.com/direct-fulfillment.md): Build a native gifting experience with Snappy as the invisible fulfillment engine. Catalog sync, ordering, and shipping at scale.
- [Duplicate Gift Detection](https://docs.snappy.com/duplicate-gifts-detection.md): Prevent accidental double-billing with idempotency keys. How to assign keys, reuse them safely, and handle conflict responses.
- [Error Handling: Snappy API Error Codes & Recovery](https://docs.snappy.com/error-handling.md): HTTP status codes, error payload shape, idempotency, and recommended retry patterns for the Snappy gifting API.
- [Gifts API: Create, Track, and Expire Gifts](https://docs.snappy.com/gifts-overview.md): Programmatically create, retrieve, update, and expire gifts. Magic-link claims, demo gifts, and webhook-triggered creation.
- [API Recipes — End-to-End Integration Guides](https://docs.snappy.com/introduction.md): End-to-end walkthroughs for the Snappy Gifting API. Build Triggered Gifting and Direct Fulfillment flows step by step with real code samples.
- [Snappy + LogicBroker Integration Guide](https://docs.snappy.com/logicbroker-integration.md): Connect Snappy to LogicBroker for advanced order routing and supplier networks. Setup, mapping, and troubleshooting.
- [Orders API: Address Validation, Cancellation & Claims](https://docs.snappy.com/orders-overview.md): Validate addresses, claim gifts, cancel orders, and autocomplete shipping data with the Snappy Orders API.
- [Webhooks Setup](https://docs.snappy.com/overview-and-setup.md): Receive real-time gift, order, and delivery events. Configure endpoints, verify signatures, and test locally before going live.
- [Products & Variants API: Catalog Access for Gifting](https://docs.snappy.com/products-and-variants-overview.md): Access Snappy's global catalog, product variants, and tags to render a native gifting marketplace in your own UI.
- [Snappy API Quickstart: Send Your First Gift in Minutes](https://docs.snappy.com/quickstart.md): Authenticate, call POST /gifts, and deliver your first Snappy gift in under 5 minutes. Step-by-step quickstart with copy-paste examples.
- [Snappy API Rate Limits & Best Practices](https://docs.snappy.com/rate-limits.md): Rate limits, retry and backoff guidance, and headers to monitor when integrating with the Snappy API.
- [Recipients API: Manage Gift Recipients at Scale](https://docs.snappy.com/recipients-overview.md): Create, retrieve, update, and delete recipients programmatically. Build recipient lists for campaigns and automated triggers.
- [Request & Response Standards](https://docs.snappy.com/request-response-standards.md): Conventions for field projection, object expansion, pagination, metadata, date formats, and error responses across the API.
- [Core Concepts & Data Models](https://docs.snappy.com/snappy-core-concepts-and-data-models.md): How Companies, Accounts, Campaigns, Gifts, Orders, and Recipients fit together in the Snappy platform.
- [Snappy MCP Server: Connect Claude & ChatGPT](https://docs.snappy.com/snappy-mcp-server.md): Plug Snappy into Claude, ChatGPT, and other MCP-compatible AI clients. Setup, supported tools, and security model.
- [Swag Store API: Build a Branded Internal Store](https://docs.snappy.com/swag-store-api.md): Use Snappy as the fulfillment engine for an internal company swag store. Catalog, ordering, and shipping examples.
- [Triggered Gifting (Recipient Choice)](https://docs.snappy.com/triggered-gifting.md): Send a magic-link gift, let the recipient choose, and Snappy handles fulfillment. Use cases, flow, and gift creation reference.
- [Webhook Event Types: Real-Time Gift Lifecycle](https://docs.snappy.com/webhook-event-types.md): Reference for every Snappy webhook event — gift claimed, order fulfilled, address validated, and more. Payload examples included.
- [Snappy Corporate Gifting API](https://docs.snappy.com/welcome-to-snappy-api.md): Embed corporate gifting into your platform with Snappy's API. Compare Triggered Gifting (recipient choice) vs. Direct Fulfillment, and ship in weeks.

## OpenAPI Specs

- [generated-openapi-v1.0.3-260430.public](https://docs.snappy.com/generated-openapi-v1.0.3-260430.public.yml)
- [generated-openapi-v1.0.2-260416-Accounts.public](https://docs.snappy.com/generated-openapi-v1.0.2-260416-Accounts.public.yml)
- [generated-openapi-v1.0.2-260416.public](https://docs.snappy.com/generated-openapi-v1.0.2-260416.public.yml)
- [generated-openapi-v1.0.1-260416.public](https://docs.snappy.com/generated-openapi-v1.0.1-260416.public.yml)
- [generated-openapi-v1-260413.public](https://docs.snappy.com/generated-openapi-v1-260413.public.yml)
- [generated-openapi.public](https://docs.snappy.com/generated-openapi.public.yml)
- [openapi](https://docs.snappy.com/api-reference/openapi.json)