Get estimated cost for campaign

curl --request GET \
  --url https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "campaignId": "abc12345",
  "totalNumberOfGifts": 1,
  "estimatedCost": {
    "estimatedTotalCost": 100,
    "estimatedTax": 0,
    "estimatedFee": 0,
    "budget": 100
  }
}

{
  "status": 400,
  "errorCode": 400001,
  "message": "Bad Request"
}

{
  "status": 401,
  "errorCode": 401001,
  "message": "Unauthorized"
}

{
  "status": 403,
  "errorCode": 403001,
  "message": "Forbidden"
}

{
  "status": 404,
  "errorCode": 404001,
  "message": "Not Found"
}

Campaigns

Get estimated cost for campaign

Use this endpoint to retrieve the projected cost of a Campaign based on its configured budget and a target number of gifts. Use this before launching a Campaign to verify available funds and confirm the expected spend.

Required fields:

campaignId - the Campaign identifier, passed as a path parameter

Optional parameters:

numberOfGifts query parameter - the number of gifts to estimate for (1-99,999, default 1)
companyId query parameter - Company ID (when not inferable from the calling key)
Request-Source header - source of the request

Please note:

The response includes the configured budget, plus estimatedFee, estimatedTax, and estimatedTotalCost per gift. Multiply by numberOfGifts to project the total Campaign spend.
Estimates use the Campaign’s default shipping country and current pricing. Actual cost per gift may vary slightly based on the recipient’s country and the variant they select.

Permissions

Requires: campaigns:read

GET

campaigns

{campaignId}

estimatedCost

Get estimated cost for campaign

curl --request GET \
  --url https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "campaignId": "abc12345",
  "totalNumberOfGifts": 1,
  "estimatedCost": {
    "estimatedTotalCost": 100,
    "estimatedTax": 0,
    "estimatedFee": 0,
    "budget": 100
  }
}

{
  "status": 400,
  "errorCode": 400001,
  "message": "Bad Request"
}

{
  "status": 401,
  "errorCode": 401001,
  "message": "Unauthorized"
}

{
  "status": 403,
  "errorCode": 403001,
  "message": "Forbidden"
}

{
  "status": 404,
  "errorCode": 404001,
  "message": "Not Found"
}

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

Create an API Key: Use the POST /v2/authentication/apiKeys endpoint to generate a new API key
Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
Optional mTLS: Enable mutual TLS for enhanced security
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:

Set enforceMtls: true when creating the API key
Contact support to obtain your client certificates
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

campaignId

string

required

Campaign ID

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

Example:

"abcd1234"

Query Parameters

companyId

string

Company ID

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

Example:

"12345678"

numberOfGifts

number

default:1

Number of gifts

Required range: 1 <= x <= 99999

Example:

1

Response

Campaign estimated cost response.

campaignId

string

required

The campaign ID.

Example:

"abcd1234"

totalNumberOfGifts

integer

required

The total number of gifts.

Example:

3

estimatedCost

object

required

The estimated cost of the gift including estimated tax and fee.

Show child attributes

Example:

{
  "budget": 100,
  "estimatedFee": 2,
  "estimatedTax": 7,
  "estimatedTotalCost": 109
}

Last modified on June 17, 2026

Update campaign by ID

Collections API (V2): Curated Gift Catalogs

Authentication

Marketplace

Gifting

Administration

Get estimated cost for campaign

Required fields:

Optional parameters:

Please note:

Permissions

Authorizations

Company Level Authentication

Getting Your API Key

Using Your API Key

API Key Management

Enhanced Security (mTLS)

Headers

Path Parameters

Query Parameters

Response