Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Gifts API

9 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

gifts.current

Read gift budgets, this month’s spend against the cap, gifts waiting for approval and recent gifts

POST/api/v1/manage/gifts/current

const result = await shuffl.gifts.current();
Request fields (none)

This operation takes no input.

Response object
  • budgets object[] required
    • amount number required
    • enabled boolean required
    • help string required
    • label string required
    • occasion "anniversary" | "birthday" | "praise" | "welcome" required
  • catalog object[] required
    • blurb string required
    • docsHref string required
    • fields object[] required
      • help string optional
      • id string required
      • label string required
      • options object[] optional
        • label string required
        • value string required
      • secret true optional
    • id "tremendous" required
    • name string required
    • steps string[] required
  • connection null | object required
    • campaign null | string required
    • campaignId null | string required
    • environment "production" | "sandbox" required
    • fundingSource null | string required
    • fundingSourceId null | string required
    • id string required
    • label string required
    • ordering boolean required
    • provider string required
    • providerName string required
    • sample boolean required
    • status "connected" | "disconnected" | "needs_attention" required
  • currency string required
  • drafts object[] required
    • amount string required
    • amountCents number required
    • approvedAt null | string required
    • approvedByName null | string required
    • createdAt string required
    • currency string required
    • draftedByShuffl boolean required
    • errorCode null | string required
    • id string required
    • linkSentAt null | string required
    • message null | string required
    • occasion "anniversary" | "birthday" | "praise" | "welcome" required
    • occasionDate string required
    • occasionLabel string required
    • ownGift boolean required
    • personId string required
    • personName string required
    • skipReason null | string optional
    • state "cancelled" | "checking" | "drafted" | "not_sent" | "sending" | "sent" | "skipped" | "waiting" required
    • stateLabel string required
  • history object[] required
    • amount string required
    • amountCents number required
    • approvedAt null | string required
    • approvedByName null | string required
    • createdAt string required
    • currency string required
    • draftedByShuffl boolean required
    • errorCode null | string required
    • id string required
    • linkSentAt null | string required
    • message null | string required
    • occasion "anniversary" | "birthday" | "praise" | "welcome" required
    • occasionDate string required
    • occasionLabel string required
    • ownGift boolean required
    • personId string required
    • personName string required
    • skipReason null | string optional
    • state "cancelled" | "checking" | "drafted" | "not_sent" | "sending" | "sent" | "skipped" | "waiting" required
    • stateLabel string required
  • message null | string required
  • month object required
    • cap null | string required
    • capAmount null | number required
    • label string required
    • left null | string required
    • percent null | number required
    • sent number required
    • spent string required
    • spentCents number required

gifts.options

List the Tremendous funding sources and campaigns gifts can use

POST/api/v1/manage/gifts/options

const result = await shuffl.gifts.options();
Request fields (none)

This operation takes no input.

Response object
  • campaigns object[] required
    • id string required
    • label string required
  • fundingSources object[] required
    • id string required
    • label string required

gifts.approve

Approve and send this gift

POST/api/v1/manage/gifts/approve

  • Write
  • Permission gifts.approve
  • Needs a requestKey
  • Needs confirm set to gifts.approve
const result = await shuffl.gifts.approve({
  "giftId": "<giftId>",
  "confirm": "gifts.approve",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • giftId string required
  • confirm "gifts.approve" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • amount string required
    • amountCents number required
    • approvedAt null | string required
    • approvedByName null | string required
    • createdAt string required
    • currency string required
    • draftedByShuffl boolean required
    • errorCode null | string required
    • id string required
    • linkSentAt null | string required
    • message null | string required
    • occasion "anniversary" | "birthday" | "praise" | "welcome" required
    • occasionDate string required
    • occasionLabel string required
    • ownGift boolean required
    • personId string required
    • personName string required
    • skipReason null | string optional
    • state "cancelled" | "checking" | "drafted" | "not_sent" | "sending" | "sent" | "skipped" | "waiting" required
    • stateLabel string required

gifts.approveMany

Approve and send these gifts

POST/api/v1/manage/gifts/approveMany

  • Write
  • Permission gifts.approveMany
  • Needs a requestKey
  • Needs confirm set to gifts.approveMany
const result = await shuffl.gifts.approveMany({
  "giftIds": [
    "<giftIds>"
  ],
  "confirm": "gifts.approveMany",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • giftIds string[] required
  • confirm "gifts.approveMany" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • approved number required
    • notApproved object[] required
      • giftId string required
      • reason string required

gifts.disconnect

Disconnect Tremendous; no more gifts are sent

POST/api/v1/manage/gifts/disconnect

  • Write
  • Permission gifts.disconnect
  • Needs a requestKey
  • Needs confirm set to gifts.disconnect
const result = await shuffl.gifts.disconnect({
  "connectionId": "<connectionId>",
  "confirm": "gifts.disconnect",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • connectionId string required
  • confirm "gifts.disconnect" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • disconnected boolean required

gifts.draft

Draft a gift for someone, such as a reward for their praise

POST/api/v1/manage/gifts/draft

  • Write
  • Permission gifts.draft
  • Needs a requestKey
  • Needs confirm set to gifts.draft
const result = await shuffl.gifts.draft({
  "occasion": "anniversary",
  "personId": "<personId>",
  "confirm": "gifts.draft",
  "requestKey": "a-new-unique-key"
});
Request fields (8)
  • amount number optional
  • message string optional
  • occasion "anniversary" | "birthday" | "praise" | "welcome" required
  • occasionDate string optional
  • personId string required
  • praiseId string optional
  • confirm "gifts.draft" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • amount string required
    • amountCents number required
    • approvedAt null | string required
    • approvedByName null | string required
    • createdAt string required
    • currency string required
    • draftedByShuffl boolean required
    • errorCode null | string required
    • id string required
    • linkSentAt null | string required
    • message null | string required
    • occasion "anniversary" | "birthday" | "praise" | "welcome" required
    • occasionDate string required
    • occasionLabel string required
    • ownGift boolean required
    • personId string required
    • personName string required
    • skipReason null | string optional
    • state "cancelled" | "checking" | "drafted" | "not_sent" | "sending" | "sent" | "skipped" | "waiting" required
    • stateLabel string required

gifts.draftUpcoming

Draft the gifts for the next two weeks of occasions now

POST/api/v1/manage/gifts/draftUpcoming

const result = await shuffl.gifts.draftUpcoming({
  "confirm": "gifts.draftUpcoming",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • confirm "gifts.draftUpcoming" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • drafted number required

gifts.save

Save gift budgets, the monthly cap and where gifts are paid from

POST/api/v1/manage/gifts/save

  • Write
  • Permission gifts.save
  • Needs a requestKey
  • Needs confirm set to gifts.save
const result = await shuffl.gifts.save({
  "confirm": "gifts.save",
  "requestKey": "a-new-unique-key"
});
Request fields (9)
  • budgets object optional
    • anniversary object optional
      • amount number required
      • enabled boolean required
    • birthday object optional
      • amount number required
      • enabled boolean required
    • praise object optional
      • amount number required
      • enabled boolean required
    • welcome object optional
      • amount number required
      • enabled boolean required
  • campaignId string optional
  • currency "AUD" | "CAD" | "EUR" | "GBP" | "USD" optional
  • fundingSourceId string optional
  • message null | string optional
  • monthlyCap null | number optional
  • ordering false | true optional
  • confirm "gifts.save" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • budgets object[] required
      • amount number required
      • enabled boolean required
      • help string required
      • label string required
      • occasion "anniversary" | "birthday" | "praise" | "welcome" required
    • catalog object[] required
      • blurb string required
      • docsHref string required
      • fields object[] required
        • help string optional
        • id string required
        • label string required
        • options object[] optional
        • secret true optional
      • id "tremendous" required
      • name string required
      • steps string[] required
    • connection null | object required
      • campaign null | string required
      • campaignId null | string required
      • environment "production" | "sandbox" required
      • fundingSource null | string required
      • fundingSourceId null | string required
      • id string required
      • label string required
      • ordering boolean required
      • provider string required
      • providerName string required
      • sample boolean required
      • status "connected" | "disconnected" | "needs_attention" required
    • currency string required
    • drafts object[] required
      • amount string required
      • amountCents number required
      • approvedAt null | string required
      • approvedByName null | string required
      • createdAt string required
      • currency string required
      • draftedByShuffl boolean required
      • errorCode null | string required
      • id string required
      • linkSentAt null | string required
      • message null | string required
      • occasion "anniversary" | "birthday" | "praise" | "welcome" required
      • occasionDate string required
      • occasionLabel string required
      • ownGift boolean required
      • personId string required
      • personName string required
      • skipReason null | string optional
      • state "cancelled" | "checking" | "drafted" | "not_sent" | "sending" | "sent" | "skipped" | "waiting" required
      • stateLabel string required
    • history object[] required
      • amount string required
      • amountCents number required
      • approvedAt null | string required
      • approvedByName null | string required
      • createdAt string required
      • currency string required
      • draftedByShuffl boolean required
      • errorCode null | string required
      • id string required
      • linkSentAt null | string required
      • message null | string required
      • occasion "anniversary" | "birthday" | "praise" | "welcome" required
      • occasionDate string required
      • occasionLabel string required
      • ownGift boolean required
      • personId string required
      • personName string required
      • skipReason null | string optional
      • state "cancelled" | "checking" | "drafted" | "not_sent" | "sending" | "sent" | "skipped" | "waiting" required
      • stateLabel string required
    • message null | string required
    • month object required
      • cap null | string required
      • capAmount null | number required
      • label string required
      • left null | string required
      • percent null | number required
      • sent number required
      • spent string required
      • spentCents number required

gifts.skip

Skip this gift; nothing is sent

POST/api/v1/manage/gifts/skip

  • Write
  • Permission gifts.skip
  • Needs a requestKey
  • Needs confirm set to gifts.skip
const result = await shuffl.gifts.skip({
  "giftId": "<giftId>",
  "confirm": "gifts.skip",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • giftId string required
  • confirm "gifts.skip" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • amount string required
    • amountCents number required
    • approvedAt null | string required
    • approvedByName null | string required
    • createdAt string required
    • currency string required
    • draftedByShuffl boolean required
    • errorCode null | string required
    • id string required
    • linkSentAt null | string required
    • message null | string required
    • occasion "anniversary" | "birthday" | "praise" | "welcome" required
    • occasionDate string required
    • occasionLabel string required
    • ownGift boolean required
    • personId string required
    • personName string required
    • skipReason null | string optional
    • state "cancelled" | "checking" | "drafted" | "not_sent" | "sending" | "sent" | "skipped" | "waiting" required
    • stateLabel string required