Snappy Public API

Campaigns
API Keys
Gifts

Coming soon - Campaigns API

Campaigns

COMING SOON - Collections API

Collections
- Get available collectionsget
- Get budgets by collection typeget

COMING SOON - Products API

Products
- Get products by collection IDget
- Get product by IDget

Snappy Public API

Campaigns
API Keys
Gifts

Coming soon - Campaigns API

Campaigns

COMING SOON - Collections API

Collections
- Get available collectionsget
- Get budgets by collection typeget

COMING SOON - Products API

Products
- Get products by collection IDget
- Get product by IDget

Get estimated cost for campaign

get https://api.snappy.com/public-api/v2/campaigns/{campaignId}/estimatedCost

Get the estimated cost for a campaign.
The estimated cost is used to calculate the budget for the campaign.

URL Expired

The URL for this request expired after 30 days.

Path Params

campaignId

string

required

The campaign id.

Query Params

companyId

string

Company id

numberOfGifts

number

1 to 99999

Defaults to 1

Number of gifts

Headers

Request-Source

string

Source of the request

Responses

Response body

object

campaignId

string

The campaign id.

totalNumberOfGifts

integer

The total number of gifts.

estimatedCost

object

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

budget

number

required

The gift budget as defined in the campaign.

estimatedFee

number

required

The estimated fee cost according to the gift budget.

estimatedTax

number

required

The estimated tax cost according to the gift budget.

estimatedTotalCost

number

required

The estimated cost of the gift including tax and fee.

Response body

object

status

integer

required

The HTTP status code.

errorCode

integer

required

Internal error code, helps Snappy's technical team to troubleshoot if needed.

message

string

required

The error message.

errors

array of objects

An array of client errors.
This field is being returned only for errors the client should fix,
usually with status code 400.

errors

object

path

string

The path of the field that caused the error.

message

string

The error message.

errorCode

integer

Internal error code, helps Snappy's technical team to troubleshoot if needed.

Response body

object

status

integer

required

The HTTP status code.

errorCode

integer

required

Internal error code, helps Snappy's technical team to troubleshoot if needed.

message

string

required

The error message.

errors

array of objects

An array of client errors.
This field is being returned only for errors the client should fix,
usually with status code 400.

errors

object

path

string

The path of the field that caused the error.

message

string

The error message.

errorCode

integer

Internal error code, helps Snappy's technical team to troubleshoot if needed.

Response body

object

status

integer

required

The HTTP status code.

errorCode

integer

required

Internal error code, helps Snappy's technical team to troubleshoot if needed.

message

string

required

The error message.

errors

array of objects

An array of client errors.
This field is being returned only for errors the client should fix,
usually with status code 400.

errors

object

path

string

The path of the field that caused the error.

message

string

The error message.

errorCode

integer

Internal error code, helps Snappy's technical team to troubleshoot if needed.

Response body

object

status

integer

required

The HTTP status code.

errorCode

integer

required

Internal error code, helps Snappy's technical team to troubleshoot if needed.

message

string

required

The error message.

errors

array of objects

An array of client errors.
This field is being returned only for errors the client should fix,
usually with status code 400.

errors

object

path

string

The path of the field that caused the error.

message

string

The error message.

errorCode

integer

Internal error code, helps Snappy's technical team to troubleshoot if needed.

Response body

object

status

integer

required

The HTTP status code.

errorCode

integer

required

Internal error code, helps Snappy's technical team to troubleshoot if needed.

message

string

required

The error message.

errors

array of objects

An array of client errors.
This field is being returned only for errors the client should fix,
usually with status code 400.

errors

object

path

string

The path of the field that caused the error.

message

string

The error message.

errorCode

integer

Internal error code, helps Snappy's technical team to troubleshoot if needed.

Updated 17 days ago

Get campaigns

API Keys

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.snappy.com/public-api/v2/campaigns/campaignId/estimatedCost \
3
     --header 'accept: application/json'


xxxxxxxxxx
10
 
1
{
2
  "campaignId": "abc12345",
3
  "totalNumberOfGifts": 1,
4
  "estimatedCost": {
5
    "estimatedTotalCost": 100,
6
    "estimatedTax": 0,
7
    "estimatedFee": 0,
8
    "budget": 100
9
  }
10
}

Updated 17 days ago

Get campaigns

API Keys

Did this page help you?

Snappy Public API
Campaigns
Get estimated cost for campaignget
Get campaignsget
Get campaign by idget
API Keys
Delete api keydelete
Create api keypost
Get api keysget
Gifts
Claim gift by ID - Coming soonpost
Create giftspost
Get giftsget
Get gift by idget

Coming soon - Campaigns API
Campaigns
Update an existing campaignpatch
Get campaign by IDget
Retrieve all campaignsget
Create a new campaignpost

COMING SOON - Collections API
Collections
Get budgets by collection typeget
Get available collectionsget

COMING SOON - Products API
Products
Get product by IDget
Get products by collection IDget

Snappy Public API
Campaigns
Get estimated cost for campaignget
Get campaignsget
Get campaign by idget
API Keys
Delete api keydelete
Create api keypost
Get api keysget
Gifts
Claim gift by ID - Coming soonpost
Create giftspost
Get giftsget
Get gift by idget

Coming soon - Campaigns API
Campaigns
Update an existing campaignpatch
Get campaign by IDget
Retrieve all campaignsget
Create a new campaignpost

COMING SOON - Collections API
Collections
Get budgets by collection typeget
Get available collectionsget

COMING SOON - Products API
Products
Get product by IDget
Get products by collection IDget

200Ok

400Bad Request

401Unauthorized

403Forbidden

404Not found

500Internal server error