Create campaign
curl --request POST \
--url https://api.snappy.com/public-api/v2/campaigns \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "My Campaign",
"accountId": "a12bcd34",
"customization": {
"giftProperties": [
{
"budget": {
"max": 100,
"min": 76
},
"expiration": {
"type": "daysFromSend",
"numberOfDays": 30
},
"guaranteedGift": {
"type": "daysFromSend",
"numberOfDays": 30
},
"collection": {
"id": "12345678",
"featuredProducts": [
"12345678"
]
},
"product": {
"id": "12345678",
"displayType": "displayAsSurprise"
}
}
],
"notificationPolicy": {
"sendingChannels": [
"mail"
],
"disableReminders": true
},
"recipientExperience": {
"type": "enterAddress",
"visualElements": {
"reveal": {
"type": "snowGlobe",
"primaryColor": "#000000",
"secondaryColor": "#000000"
},
"greeting": {
"content": {
"ops": [
{
"insert": "Happy Birthday!"
}
]
},
"banner": {
"text": "Happy Birthday!",
"color": "#000000",
"mediaItems": {
"background": [
{
"type": "image",
"url": "https://example.com/image.jpg"
}
]
}
}
},
"postClaim": {
"redirectAfterClaim": "https://example.com/redirect"
}
}
}
}
}
'import requests
url = "https://api.snappy.com/public-api/v2/campaigns"
payload = {
"name": "My Campaign",
"accountId": "a12bcd34",
"customization": {
"giftProperties": [
{
"budget": {
"max": 100,
"min": 76
},
"expiration": {
"type": "daysFromSend",
"numberOfDays": 30
},
"guaranteedGift": {
"type": "daysFromSend",
"numberOfDays": 30
},
"collection": {
"id": "12345678",
"featuredProducts": ["12345678"]
},
"product": {
"id": "12345678",
"displayType": "displayAsSurprise"
}
}
],
"notificationPolicy": {
"sendingChannels": ["mail"],
"disableReminders": True
},
"recipientExperience": {
"type": "enterAddress",
"visualElements": {
"reveal": {
"type": "snowGlobe",
"primaryColor": "#000000",
"secondaryColor": "#000000"
},
"greeting": {
"content": { "ops": [{ "insert": "Happy Birthday!" }] },
"banner": {
"text": "Happy Birthday!",
"color": "#000000",
"mediaItems": { "background": [
{
"type": "image",
"url": "https://example.com/image.jpg"
}
] }
}
},
"postClaim": { "redirectAfterClaim": "https://example.com/redirect" }
}
}
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Campaign',
accountId: 'a12bcd34',
customization: {
giftProperties: [
{
budget: {max: 100, min: 76},
expiration: {type: 'daysFromSend', numberOfDays: 30},
guaranteedGift: {type: 'daysFromSend', numberOfDays: 30},
collection: {id: '12345678', featuredProducts: ['12345678']},
product: {id: '12345678', displayType: 'displayAsSurprise'}
}
],
notificationPolicy: {sendingChannels: ['mail'], disableReminders: true},
recipientExperience: {
type: 'enterAddress',
visualElements: {
reveal: {type: 'snowGlobe', primaryColor: '#000000', secondaryColor: '#000000'},
greeting: {
content: {ops: [{insert: 'Happy Birthday!'}]},
banner: {
text: 'Happy Birthday!',
color: '#000000',
mediaItems: {background: [{type: 'image', url: 'https://example.com/image.jpg'}]}
}
},
postClaim: {redirectAfterClaim: 'https://example.com/redirect'}
}
}
}
})
};
fetch('https://api.snappy.com/public-api/v2/campaigns', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My Campaign',
'accountId' => 'a12bcd34',
'customization' => [
'giftProperties' => [
[
'budget' => [
'max' => 100,
'min' => 76
],
'expiration' => [
'type' => 'daysFromSend',
'numberOfDays' => 30
],
'guaranteedGift' => [
'type' => 'daysFromSend',
'numberOfDays' => 30
],
'collection' => [
'id' => '12345678',
'featuredProducts' => [
'12345678'
]
],
'product' => [
'id' => '12345678',
'displayType' => 'displayAsSurprise'
]
]
],
'notificationPolicy' => [
'sendingChannels' => [
'mail'
],
'disableReminders' => true
],
'recipientExperience' => [
'type' => 'enterAddress',
'visualElements' => [
'reveal' => [
'type' => 'snowGlobe',
'primaryColor' => '#000000',
'secondaryColor' => '#000000'
],
'greeting' => [
'content' => [
'ops' => [
[
'insert' => 'Happy Birthday!'
]
]
],
'banner' => [
'text' => 'Happy Birthday!',
'color' => '#000000',
'mediaItems' => [
'background' => [
[
'type' => 'image',
'url' => 'https://example.com/image.jpg'
]
]
]
]
],
'postClaim' => [
'redirectAfterClaim' => 'https://example.com/redirect'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snappy.com/public-api/v2/campaigns"
payload := strings.NewReader("{\n \"name\": \"My Campaign\",\n \"accountId\": \"a12bcd34\",\n \"customization\": {\n \"giftProperties\": [\n {\n \"budget\": {\n \"max\": 100,\n \"min\": 76\n },\n \"expiration\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"guaranteedGift\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"collection\": {\n \"id\": \"12345678\",\n \"featuredProducts\": [\n \"12345678\"\n ]\n },\n \"product\": {\n \"id\": \"12345678\",\n \"displayType\": \"displayAsSurprise\"\n }\n }\n ],\n \"notificationPolicy\": {\n \"sendingChannels\": [\n \"mail\"\n ],\n \"disableReminders\": true\n },\n \"recipientExperience\": {\n \"type\": \"enterAddress\",\n \"visualElements\": {\n \"reveal\": {\n \"type\": \"snowGlobe\",\n \"primaryColor\": \"#000000\",\n \"secondaryColor\": \"#000000\"\n },\n \"greeting\": {\n \"content\": {\n \"ops\": [\n {\n \"insert\": \"Happy Birthday!\"\n }\n ]\n },\n \"banner\": {\n \"text\": \"Happy Birthday!\",\n \"color\": \"#000000\",\n \"mediaItems\": {\n \"background\": [\n {\n \"type\": \"image\",\n \"url\": \"https://example.com/image.jpg\"\n }\n ]\n }\n }\n },\n \"postClaim\": {\n \"redirectAfterClaim\": \"https://example.com/redirect\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.snappy.com/public-api/v2/campaigns")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Campaign\",\n \"accountId\": \"a12bcd34\",\n \"customization\": {\n \"giftProperties\": [\n {\n \"budget\": {\n \"max\": 100,\n \"min\": 76\n },\n \"expiration\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"guaranteedGift\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"collection\": {\n \"id\": \"12345678\",\n \"featuredProducts\": [\n \"12345678\"\n ]\n },\n \"product\": {\n \"id\": \"12345678\",\n \"displayType\": \"displayAsSurprise\"\n }\n }\n ],\n \"notificationPolicy\": {\n \"sendingChannels\": [\n \"mail\"\n ],\n \"disableReminders\": true\n },\n \"recipientExperience\": {\n \"type\": \"enterAddress\",\n \"visualElements\": {\n \"reveal\": {\n \"type\": \"snowGlobe\",\n \"primaryColor\": \"#000000\",\n \"secondaryColor\": \"#000000\"\n },\n \"greeting\": {\n \"content\": {\n \"ops\": [\n {\n \"insert\": \"Happy Birthday!\"\n }\n ]\n },\n \"banner\": {\n \"text\": \"Happy Birthday!\",\n \"color\": \"#000000\",\n \"mediaItems\": {\n \"background\": [\n {\n \"type\": \"image\",\n \"url\": \"https://example.com/image.jpg\"\n }\n ]\n }\n }\n },\n \"postClaim\": {\n \"redirectAfterClaim\": \"https://example.com/redirect\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snappy.com/public-api/v2/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Campaign\",\n \"accountId\": \"a12bcd34\",\n \"customization\": {\n \"giftProperties\": [\n {\n \"budget\": {\n \"max\": 100,\n \"min\": 76\n },\n \"expiration\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"guaranteedGift\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"collection\": {\n \"id\": \"12345678\",\n \"featuredProducts\": [\n \"12345678\"\n ]\n },\n \"product\": {\n \"id\": \"12345678\",\n \"displayType\": \"displayAsSurprise\"\n }\n }\n ],\n \"notificationPolicy\": {\n \"sendingChannels\": [\n \"mail\"\n ],\n \"disableReminders\": true\n },\n \"recipientExperience\": {\n \"type\": \"enterAddress\",\n \"visualElements\": {\n \"reveal\": {\n \"type\": \"snowGlobe\",\n \"primaryColor\": \"#000000\",\n \"secondaryColor\": \"#000000\"\n },\n \"greeting\": {\n \"content\": {\n \"ops\": [\n {\n \"insert\": \"Happy Birthday!\"\n }\n ]\n },\n \"banner\": {\n \"text\": \"Happy Birthday!\",\n \"color\": \"#000000\",\n \"mediaItems\": {\n \"background\": [\n {\n \"type\": \"image\",\n \"url\": \"https://example.com/image.jpg\"\n }\n ]\n }\n }\n },\n \"postClaim\": {\n \"redirectAfterClaim\": \"https://example.com/redirect\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "abcd1234",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"name": "Campaign Name",
"accountId": "a12bcd34",
"companyId": "A1b2C3d4",
"status": "draft",
"source": "api_native",
"account": {
"id": "a12bcd34",
"name": "Account Name"
},
"type": "oneOffs",
"giftsExpirationInDays": 30,
"giftExpirationDate": "<string>",
"properties": [
{
"budget": 100,
"collection": {
"id": "abcdef12",
"name": "Collection Name",
"defaultCountry": "US"
}
}
],
"customization": {
"giftProperties": [
{
"selectedGiftType": "collection",
"budget": {
"max": 100,
"min": 76
},
"expiration": {
"type": "daysFromSend",
"numberOfDays": 30
},
"guaranteedGift": {
"type": "daysFromSend",
"numberOfDays": 30
},
"collection": {
"id": "12345678",
"featuredProducts": [
"12345678"
]
},
"product": {
"id": "12345678",
"displayType": "displayAsSurprise"
}
}
],
"notificationPolicy": {
"sendingChannels": [
"mail"
],
"disableReminders": true
},
"recipientExperience": {
"type": "enterAddress",
"visualElements": {
"reveal": {
"type": "snowGlobe",
"primaryColor": "#000000",
"secondaryColor": "#000000"
},
"greeting": {
"content": {
"ops": [
{
"insert": "Happy Birthday!"
}
]
},
"banner": {
"text": "Happy Birthday!",
"color": "#000000",
"mediaItems": {
"background": [
{
"type": "image",
"url": "https://example.com/image.jpg"
}
]
}
}
},
"postClaim": {
"redirectAfterClaim": "https://example.com/redirect"
}
}
}
}
}{
"status": 400,
"errorCode": "400_PBLC_001",
"message": "Bad Request"
}{
"status": 401,
"errorCode": "401_PBLC_001",
"message": "Unauthorized"
}{
"status": 403,
"errorCode": "403_PBLC_001",
"message": "This API key doesn't have permission to access this endpoint."
}{
"status": 409,
"errorCode": "409_PBLC_001",
"message": "Conflict"
}{
"status": 422,
"errorCode": "422_PBLC_001",
"message": "Unprocessable entity"
}Campaigns
Create campaign
Use this endpoint to create a new Campaign under an Account. When created via the API, the Campaign is automatically assigned the Account’s default Billing Method.
Required fields:
name- display name of the Campaign (must be unique within the Company)accountId- the Account this Campaign belongs tocustomization- Gift Customization configuration (giftProperties,notificationPolicy, optionallyrecipientExperience)
Optional parameters:
Request-Sourceheader - source of the request (api_native,api_zapier,api_salesforce,api_ftp,api_make)
Behavior Notes:
- Returns
201with the new Campaign on success. - Campaigns created via the API are always created with
type: oneOffs. Other Campaign types (anniversary,birthday,schedule,marketing,newHire) can only be created through the Snappy Dashboard. - Returns
409when a Campaign with the same name already exists in the Company. - Returns
422for business-rule violations (e.g. invalid Collection/Product reference, conflicting customization).
Permissions
- Requires:
campaigns:create
POST
/
v2
/
campaigns
Create campaign
curl --request POST \
--url https://api.snappy.com/public-api/v2/campaigns \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "My Campaign",
"accountId": "a12bcd34",
"customization": {
"giftProperties": [
{
"budget": {
"max": 100,
"min": 76
},
"expiration": {
"type": "daysFromSend",
"numberOfDays": 30
},
"guaranteedGift": {
"type": "daysFromSend",
"numberOfDays": 30
},
"collection": {
"id": "12345678",
"featuredProducts": [
"12345678"
]
},
"product": {
"id": "12345678",
"displayType": "displayAsSurprise"
}
}
],
"notificationPolicy": {
"sendingChannels": [
"mail"
],
"disableReminders": true
},
"recipientExperience": {
"type": "enterAddress",
"visualElements": {
"reveal": {
"type": "snowGlobe",
"primaryColor": "#000000",
"secondaryColor": "#000000"
},
"greeting": {
"content": {
"ops": [
{
"insert": "Happy Birthday!"
}
]
},
"banner": {
"text": "Happy Birthday!",
"color": "#000000",
"mediaItems": {
"background": [
{
"type": "image",
"url": "https://example.com/image.jpg"
}
]
}
}
},
"postClaim": {
"redirectAfterClaim": "https://example.com/redirect"
}
}
}
}
}
'import requests
url = "https://api.snappy.com/public-api/v2/campaigns"
payload = {
"name": "My Campaign",
"accountId": "a12bcd34",
"customization": {
"giftProperties": [
{
"budget": {
"max": 100,
"min": 76
},
"expiration": {
"type": "daysFromSend",
"numberOfDays": 30
},
"guaranteedGift": {
"type": "daysFromSend",
"numberOfDays": 30
},
"collection": {
"id": "12345678",
"featuredProducts": ["12345678"]
},
"product": {
"id": "12345678",
"displayType": "displayAsSurprise"
}
}
],
"notificationPolicy": {
"sendingChannels": ["mail"],
"disableReminders": True
},
"recipientExperience": {
"type": "enterAddress",
"visualElements": {
"reveal": {
"type": "snowGlobe",
"primaryColor": "#000000",
"secondaryColor": "#000000"
},
"greeting": {
"content": { "ops": [{ "insert": "Happy Birthday!" }] },
"banner": {
"text": "Happy Birthday!",
"color": "#000000",
"mediaItems": { "background": [
{
"type": "image",
"url": "https://example.com/image.jpg"
}
] }
}
},
"postClaim": { "redirectAfterClaim": "https://example.com/redirect" }
}
}
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Campaign',
accountId: 'a12bcd34',
customization: {
giftProperties: [
{
budget: {max: 100, min: 76},
expiration: {type: 'daysFromSend', numberOfDays: 30},
guaranteedGift: {type: 'daysFromSend', numberOfDays: 30},
collection: {id: '12345678', featuredProducts: ['12345678']},
product: {id: '12345678', displayType: 'displayAsSurprise'}
}
],
notificationPolicy: {sendingChannels: ['mail'], disableReminders: true},
recipientExperience: {
type: 'enterAddress',
visualElements: {
reveal: {type: 'snowGlobe', primaryColor: '#000000', secondaryColor: '#000000'},
greeting: {
content: {ops: [{insert: 'Happy Birthday!'}]},
banner: {
text: 'Happy Birthday!',
color: '#000000',
mediaItems: {background: [{type: 'image', url: 'https://example.com/image.jpg'}]}
}
},
postClaim: {redirectAfterClaim: 'https://example.com/redirect'}
}
}
}
})
};
fetch('https://api.snappy.com/public-api/v2/campaigns', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My Campaign',
'accountId' => 'a12bcd34',
'customization' => [
'giftProperties' => [
[
'budget' => [
'max' => 100,
'min' => 76
],
'expiration' => [
'type' => 'daysFromSend',
'numberOfDays' => 30
],
'guaranteedGift' => [
'type' => 'daysFromSend',
'numberOfDays' => 30
],
'collection' => [
'id' => '12345678',
'featuredProducts' => [
'12345678'
]
],
'product' => [
'id' => '12345678',
'displayType' => 'displayAsSurprise'
]
]
],
'notificationPolicy' => [
'sendingChannels' => [
'mail'
],
'disableReminders' => true
],
'recipientExperience' => [
'type' => 'enterAddress',
'visualElements' => [
'reveal' => [
'type' => 'snowGlobe',
'primaryColor' => '#000000',
'secondaryColor' => '#000000'
],
'greeting' => [
'content' => [
'ops' => [
[
'insert' => 'Happy Birthday!'
]
]
],
'banner' => [
'text' => 'Happy Birthday!',
'color' => '#000000',
'mediaItems' => [
'background' => [
[
'type' => 'image',
'url' => 'https://example.com/image.jpg'
]
]
]
]
],
'postClaim' => [
'redirectAfterClaim' => 'https://example.com/redirect'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snappy.com/public-api/v2/campaigns"
payload := strings.NewReader("{\n \"name\": \"My Campaign\",\n \"accountId\": \"a12bcd34\",\n \"customization\": {\n \"giftProperties\": [\n {\n \"budget\": {\n \"max\": 100,\n \"min\": 76\n },\n \"expiration\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"guaranteedGift\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"collection\": {\n \"id\": \"12345678\",\n \"featuredProducts\": [\n \"12345678\"\n ]\n },\n \"product\": {\n \"id\": \"12345678\",\n \"displayType\": \"displayAsSurprise\"\n }\n }\n ],\n \"notificationPolicy\": {\n \"sendingChannels\": [\n \"mail\"\n ],\n \"disableReminders\": true\n },\n \"recipientExperience\": {\n \"type\": \"enterAddress\",\n \"visualElements\": {\n \"reveal\": {\n \"type\": \"snowGlobe\",\n \"primaryColor\": \"#000000\",\n \"secondaryColor\": \"#000000\"\n },\n \"greeting\": {\n \"content\": {\n \"ops\": [\n {\n \"insert\": \"Happy Birthday!\"\n }\n ]\n },\n \"banner\": {\n \"text\": \"Happy Birthday!\",\n \"color\": \"#000000\",\n \"mediaItems\": {\n \"background\": [\n {\n \"type\": \"image\",\n \"url\": \"https://example.com/image.jpg\"\n }\n ]\n }\n }\n },\n \"postClaim\": {\n \"redirectAfterClaim\": \"https://example.com/redirect\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.snappy.com/public-api/v2/campaigns")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Campaign\",\n \"accountId\": \"a12bcd34\",\n \"customization\": {\n \"giftProperties\": [\n {\n \"budget\": {\n \"max\": 100,\n \"min\": 76\n },\n \"expiration\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"guaranteedGift\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"collection\": {\n \"id\": \"12345678\",\n \"featuredProducts\": [\n \"12345678\"\n ]\n },\n \"product\": {\n \"id\": \"12345678\",\n \"displayType\": \"displayAsSurprise\"\n }\n }\n ],\n \"notificationPolicy\": {\n \"sendingChannels\": [\n \"mail\"\n ],\n \"disableReminders\": true\n },\n \"recipientExperience\": {\n \"type\": \"enterAddress\",\n \"visualElements\": {\n \"reveal\": {\n \"type\": \"snowGlobe\",\n \"primaryColor\": \"#000000\",\n \"secondaryColor\": \"#000000\"\n },\n \"greeting\": {\n \"content\": {\n \"ops\": [\n {\n \"insert\": \"Happy Birthday!\"\n }\n ]\n },\n \"banner\": {\n \"text\": \"Happy Birthday!\",\n \"color\": \"#000000\",\n \"mediaItems\": {\n \"background\": [\n {\n \"type\": \"image\",\n \"url\": \"https://example.com/image.jpg\"\n }\n ]\n }\n }\n },\n \"postClaim\": {\n \"redirectAfterClaim\": \"https://example.com/redirect\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snappy.com/public-api/v2/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Campaign\",\n \"accountId\": \"a12bcd34\",\n \"customization\": {\n \"giftProperties\": [\n {\n \"budget\": {\n \"max\": 100,\n \"min\": 76\n },\n \"expiration\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"guaranteedGift\": {\n \"type\": \"daysFromSend\",\n \"numberOfDays\": 30\n },\n \"collection\": {\n \"id\": \"12345678\",\n \"featuredProducts\": [\n \"12345678\"\n ]\n },\n \"product\": {\n \"id\": \"12345678\",\n \"displayType\": \"displayAsSurprise\"\n }\n }\n ],\n \"notificationPolicy\": {\n \"sendingChannels\": [\n \"mail\"\n ],\n \"disableReminders\": true\n },\n \"recipientExperience\": {\n \"type\": \"enterAddress\",\n \"visualElements\": {\n \"reveal\": {\n \"type\": \"snowGlobe\",\n \"primaryColor\": \"#000000\",\n \"secondaryColor\": \"#000000\"\n },\n \"greeting\": {\n \"content\": {\n \"ops\": [\n {\n \"insert\": \"Happy Birthday!\"\n }\n ]\n },\n \"banner\": {\n \"text\": \"Happy Birthday!\",\n \"color\": \"#000000\",\n \"mediaItems\": {\n \"background\": [\n {\n \"type\": \"image\",\n \"url\": \"https://example.com/image.jpg\"\n }\n ]\n }\n }\n },\n \"postClaim\": {\n \"redirectAfterClaim\": \"https://example.com/redirect\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "abcd1234",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"name": "Campaign Name",
"accountId": "a12bcd34",
"companyId": "A1b2C3d4",
"status": "draft",
"source": "api_native",
"account": {
"id": "a12bcd34",
"name": "Account Name"
},
"type": "oneOffs",
"giftsExpirationInDays": 30,
"giftExpirationDate": "<string>",
"properties": [
{
"budget": 100,
"collection": {
"id": "abcdef12",
"name": "Collection Name",
"defaultCountry": "US"
}
}
],
"customization": {
"giftProperties": [
{
"selectedGiftType": "collection",
"budget": {
"max": 100,
"min": 76
},
"expiration": {
"type": "daysFromSend",
"numberOfDays": 30
},
"guaranteedGift": {
"type": "daysFromSend",
"numberOfDays": 30
},
"collection": {
"id": "12345678",
"featuredProducts": [
"12345678"
]
},
"product": {
"id": "12345678",
"displayType": "displayAsSurprise"
}
}
],
"notificationPolicy": {
"sendingChannels": [
"mail"
],
"disableReminders": true
},
"recipientExperience": {
"type": "enterAddress",
"visualElements": {
"reveal": {
"type": "snowGlobe",
"primaryColor": "#000000",
"secondaryColor": "#000000"
},
"greeting": {
"content": {
"ops": [
{
"insert": "Happy Birthday!"
}
]
},
"banner": {
"text": "Happy Birthday!",
"color": "#000000",
"mediaItems": {
"background": [
{
"type": "image",
"url": "https://example.com/image.jpg"
}
]
}
}
},
"postClaim": {
"redirectAfterClaim": "https://example.com/redirect"
}
}
}
}
}{
"status": 400,
"errorCode": "400_PBLC_001",
"message": "Bad Request"
}{
"status": 401,
"errorCode": "401_PBLC_001",
"message": "Unauthorized"
}{
"status": 403,
"errorCode": "403_PBLC_001",
"message": "This API key doesn't have permission to access this endpoint."
}{
"status": 409,
"errorCode": "409_PBLC_001",
"message": "Conflict"
}{
"status": 422,
"errorCode": "422_PBLC_001",
"message": "Unprocessable entity"
}Authorizations
CompanyLevelAuthenticationBearerAuthentication
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/apiKeysendpoint 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: truewhen creating the API key - Contact support to obtain your client certificates
- Use the mTLS endpoint:
https://mtls-api.snappy.com/public-api
Headers
Source of the request
Available options:
api_native, api_zapier, api_salesforce, api_ftp, api_make Example:
"api_native"
Body
application/json
Request body for creating a campaign.
The name of the campaign
Example:
"My Campaign"
The account ID this campaign belongs to
Example:
"a12bcd34"
Campaign customization defines the entire gift recipient experience. It includes budget parameters, collection or product selection, expiration settings, notification methods, and visual presentation elements that create a cohesive branded experience.
Show child attributes
Show child attributes
Response
Campaign created successfully
Campaign details including configuration and customization.
The id of the campaign.
Example:
"abcd1234"
The date when the campaign was created.
Example:
"2021-01-01T00:00:00.000Z"
The date when the campaign was last updated.
Example:
"2021-01-01T00:00:00.000Z"
The name of the campaign.
Example:
"Campaign Name"
The id of the account.
Example:
"a12bcd34"
The id of the company.
Example:
"A1b2C3d4"
The status of the campaign.
Available options:
live, sent, draft, paused, pending, scheduled, archived, active Example:
"draft"
The source of the campaign.
Available options:
dashboard, dashboard_ai, api_native, api_zapier, api_make, api_salesforce, api_ftp Example:
"api_native"
The account of the campaign.
Show child attributes
Show child attributes
The type of the campaign. valid values are: anniversary, birthday, schedule, marketing, oneOffs, newHire.
Available options:
anniversary, birthday, schedule, marketing, oneOffs, newHire Example:
"oneOffs"
The number of days until the gifts will expire. The default value is 30 days.
Example:
30
The date when the gift will expire. Date Format: YYYY-MM-DDThh:mm:ss.sZ.
The properties of the campaign.
Show child attributes
Show child attributes
Campaign customization defines the entire gift recipient experience. It includes budget parameters, collection or product selection, expiration settings, notification methods, and visual presentation elements that create a cohesive branded experience.
Show child attributes
Show child attributes
Last modified on June 17, 2026
Was this page helpful?