Skip to main content
POST
/
v2
/
gifts
/
{giftId}
/
claim
Claim a gift
curl --request POST \
  --url https://api.snappy.com/public-api/v2/gifts/{giftId}/claim \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "variantId": "ab6789cd",
  "orderRecipient": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "country": "US",
    "address": {
      "addressLine1": "123 Main St",
      "zipcode": "12345",
      "city": "New York",
      "state": "NY"
    }
  }
}
'
{
  "orderId": "a67bc89d",
  "status": "processing"
}

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.

Authorizations

​
X-Api-Key
string
header
required

Company Level Authentication

Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.

Getting Your API Key

  1. Create an API Key: Use the POST /v2/authentication/apiKeys endpoint to generate a new API key
  2. Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
  3. Optional mTLS: Enable mutual TLS for enhanced security
  4. Name Your Key: Provide a descriptive name for easy identification

Using Your API Key

Include your API key in the X-Api-Key header for every request:

X-Api-Key: YOUR_24_CHARACTER_API_KEY

API Key Management

  • Maximum Keys: Up to 3 active API keys per company
  • Rotation: Delete old keys before creating new ones when at the limit
  • Security: Keys are hashed and cannot be retrieved after creation

Enhanced Security (mTLS)

For production environments, enable mutual TLS authentication:

  1. Set enforceMtls: true when creating the API key
  2. Contact support to obtain your client certificates
  3. Use the mTLS endpoint: https://mtls-api.snappy.com/public-api

Headers

​
Request-Source
enum<string>

Source of the request

Available options:
api_native,
api_zapier,
api_salesforce,
api_ftp,
api_make
Example:

"api_native"

Path Parameters

​
giftId
string
required

The id of the gift.

Pattern: ^[A-Za-z0-9]{8,}$
Example:

"abc123de"

Query Parameters

​
companyId
string

Company ID

Pattern: ^[A-Za-z0-9]{8,}$
Example:

"12345678"

Body

application/json

Claim gift request body.

​
variantId
string
required

Id of the selected variation (required)

Example:

"ab6789cd"

​
orderRecipient
object
required

Order recipient details.

Example:
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "country": "US",
  "address": {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 1",
    "zipcode": "12345",
    "city": "New York",
    "state": "NY"
  }
}

Response

Ok

Claim gift response.

​
orderId
string
required

Id of the order

Example:

"a67bc89d"

​
status
string
required
Example:

"processing"

Last modified on April 30, 2026