RevSend API

Send physical gifts, handwritten notes and digital gift cards from your own product or workflow. 51 operations, one GraphQL endpoint: https://graph.v2.revsend.com/

Getting started

The RevSend API is a GraphQL API. Send every request as an HTTP POST with a JSON body to one endpoint:

https://graph.v2.revsend.com/

All requests need an API key. Amounts are in cents unless a field says otherwise, and timestamps are ISO 8601 in UTC.

Your first request

curl https://graph.v2.revsend.com/ \
  -H "Authorization: Bearer $REVSEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"{ me { id name email role } }"}'

A successful response has a data object. Problems come back in an errors array, sometimes with HTTP 400; see Errors.

Authentication

Create keys in the RevSend app under Integrations > API Keys. A key is shown once, starts with rk_, and belongs to the user who created it. Requests made with the key act as that user: they spend that user's budget, show that user as the sender, and can only see what that user can see.

Send the key in the Authorization header:

Authorization: Bearer rk_<publicId>_<secret>

Authorization: ApiKey rk_... also works. Keys can be given an expiry date and can be rotated or revoked in the app at any time.

Tip for platforms: create a dedicated RevSend user for your integration (a regular user, not an org admin) and create the key as that user. That keeps your integration's orders, budget and permissions separate from your team's.

Scopes

Each key has one or more scopes. Operations that need a scope list it in their reference entry.

Scope	Allows
`campaigns:read`	List campaigns.
`campaigns:write`	Create and update physical and digital campaigns.
`orders:read`	List and export orders.
`orders:write`	Create, bulk create and send physical and digital orders, and write handwritten notes.

Operations without a scope badge accept any valid key and follow the key user's role, so a regular user key cannot run org admin operations.

Common tasks

Send a gift link

Use this when you do not have the recipient's address. RevSend returns a link you can put in your own email, LinkedIn message or sequence step. The recipient opens it, picks a gift if you offered more than one, and enters their address.

mutation {
  physicalOrderCreate(input: {
    campaignId: "CAMPAIGN_ID"
    recipient: { name: "Jordan Lee", email: "jordan@example.com", orgName: "Acme" }
    message: "Jordan, a small thank you for your time this week."
    recipientSubmitsAddress: true
    includeClaimUrl: true
    sendEmail: false
  }) {
    id
    claimUrl
    expiresAt
  }
}

Ship to an address you already have

mutation {
  physicalOrderCreate(input: {
    giftIds: [{ id: "GIFT_ID" }]
    recipient: { name: "Jordan Lee", email: "jordan@example.com", orgName: "Acme" }
    mailingAddress: {
      firstName: "Jordan", lastName: "Lee", company: "Acme"
      address1: "123 Main St", city: "Austin", provinceCode: "TX", zip: "78701", countryCode: "US"
    }
    validateAddress: true
    includeHandWritten: true
    physicalNote: "Jordan, congrats on the launch!"
  }) {
    id
    ref
  }
}

Let the recipient choose

Pass several gifts in giftIds (or use a campaign with several giftOptions) and leave sendAll unset. The claim page shows every option and the recipient picks one. Set sendAll: true to ship all of them together in one package instead.

Call the recommendation endpoint with what you know about the person.
Pick a result and pass its sourceUrl, title, imageUrl, priceCents and storeName to physicalOrderCreateWithImport as purchaseUrl, title, images, priceCents and source.
RevSend buys the item, repackages it in your branded box at our warehouse and ships it with your note.

Track an order

Query physicalOrder(id) for fulfillmentEvents, trackingUrl, selectedGifts and cancelledAt, or register a webhook to be told when an order ships or is delivered.

Send under your customer's brand

Create a brand template per brand with orgBrandTemplateCreate and pass its ID as brandTemplateId on each order. The claim page, emails and handwritten note use that template's logo, colors and handwriting style.

Recipient privacy: addresses that recipients enter are used only to ship the gift. They are never returned by the API, shown in the app or included in webhooks.

Meeting-gated gifts: requireBookedMeeting unlocks every meeting-gated gift to a recipient as soon as that person has ever been on a meeting with the sending user, on the user's Outlook or Google calendar. Cancelling the meeting does not lock the gifts again. Meetings where everyone else shares the sender's email domain do not count. When every order is sent from one integration user, connect that user's calendar or leave meeting gating off.

Gift recommendations

Get ranked gift ideas for a person from free text: a LinkedIn summary, a CRM note, recent posts, or a few sentences you write yourself. The recommendation engine reads it, picks themes and searches the catalog.

POST https://graph.v2.revsend.com/api/gift-recommendations

Body field	Type	Notes
`recipientInfo`required	string	Anything you know about the person.
`count`required	integer	How many ideas to return, 1 to 20.
`budgetMin`	number	Lowest price in US dollars. Defaults to 0.
`budgetMax`	number	Highest price in US dollars. Defaults to 500.

curl https://graph.v2.revsend.com/api/gift-recommendations \
  -H "Authorization: Bearer $REVSEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipientInfo": "VP Sales at Acme. USC alum, posts about golf and cold brew. Just closed a Series B.",
    "count": 3,
    "budgetMax": 120
  }'

{
  "recommendations": [
    {
      "productId": "...",
      "title": "USC Trojans Leather Golf Ball Marker Set",
      "oneLinePitch": "School pride for the course.",
      "priceCents": 4800,
      "currency": "USD",
      "imageUrl": "https://...",
      "sourceUrl": "https://...",
      "storeName": "...",
      "rationale": "Combines two interests from the profile: USC and golf.",
      "variants": []
    }
  ],
  "recipientProfile": {
    "occasionSlug": "congratulations",
    "personaSlugs": ["sales-leader"],
    "interests": ["golf", "coffee", "USC"],
    "tone": "celebratory",
    "relationshipContext": "prospect"
  }
}

Status	Meaning
400	The body is missing `recipientInfo`, `count` is out of range, or `budgetMin` is above `budgetMax`.
401	Missing, revoked or expired API key.
404	No gifts matched the budget and profile. Widen the budget or add detail.

Webhook events

Register an HTTPS URL with integrationWebhookCreate. RevSend sends a JSON POST for every matching event in your organization. Delivery is best effort: respond with a 2xx quickly and do your processing afterwards, and use physicalOrder or digitalOrder to confirm state if you miss an event.

Include a long random token in your webhook URL (for example https://example.com/hooks/revsend/7f3c...) and reject requests that do not carry it.

ORDER_CREATE

Sent when an order is created.

{
  "order": {
    "id": "clx...",
    "value": 85.5,
    "message": "Jordan, a small thank you for your time this week.",
    "emailSubject": "A gift for you",
    "deliveryMethod": "LINK"
  },
  "recipient": { "name": "Jordan Lee", "email": "jordan@example.com", "orgName": "Acme" },
  "sender": { "id": "...", "email": "...", "name": "...", "teamId": "...", "teamName": "..." }
}

ORDER_STATUS_UPDATE

Sent as a physical order moves along. order.status is one of:

status	When
`Viewed`	The recipient opened the claim link.
`Address Submitted`	The recipient entered their address (and chose a gift, if offered a choice).
`SHIPPED`	The package is in transit.
`DELIVERED`	The carrier reported delivery.
`NOT DELIVERED`	The carrier reported a delivery failure.

{
  "order": { "id": "clx...", "status": "DELIVERED", "value": 85.5 },
  "recipient": { "name": "Jordan Lee", "email": "jordan@example.com", "orgName": "Acme" },
  "sender": { "id": "...", "email": "...", "name": "...", "teamId": "...", "teamName": "..." }
}

order.id is the same order ID the API returns, so you can pass it straight to physicalOrder. value is in US dollars. Webhook payloads never include recipient addresses.

Errors

Every error comes back as JSON with an errors array. Each error has a message and an extensions.code. Requests stopped before the operation runs (a missing or invalid API key, a malformed query, or a rate limit) return HTTP 400. Errors raised while the operation runs, such as a missing scope or an invalid argument, return HTTP 200. Check extensions.code rather than the HTTP status.

Code	Meaning
`UNAUTHENTICATED`	Missing, malformed, revoked or expired API key.
`FORBIDDEN`	The key is valid but is missing a scope, or the key's user is not allowed to do this.
`BAD_USER_INPUT`	An argument is invalid. The message says which one.
`TOO_MANY_REQUESTS`	Rate limit reached. Wait and retry with backoff.
`INTERNAL_SERVER_ERROR`	Something failed on our side. Safe to retry reads; for writes, check whether the order was created before retrying.

{
  "errors": [
    {
      "message": "Context creation failed: Invalid / Expired Session. Please login again.",
      "extensions": { "code": "UNAUTHENTICATED" }
    }
  ]
}

Rate limits

Limit	Value
Requests per API key user	240 per 60 seconds
Requests per IP address	120 per 60 seconds
Requests per operation per IP address	40 per 60 seconds
Query depth	16 levels
Aliases per request	50

Each alias in a request counts as one more request toward these limits. Bulk endpoints are the better choice for large sends: physicalOrderBulkCreate and digitalOrderBulkCreate queue many orders in one call.

Account

Every API key belongs to one RevSend user. Requests act as that user, spend that user's budget and appear in that user's order history.

meQuery

The user the API key belongs to, including role, teams and current budget (budget.amount).

query me: User

Returns User

query {
  me {
    id
    name
    email
    role
    budget { amount }
  }
}

orgQuery

The organization the API key belongs to, including its brand templates.

query org: Org

Returns Org

Gift catalog

Physical gifts live in your organization's catalog. Use the catalog queries to browse what you can send, or import any product from the web and send it like a catalog gift.

physicalGiftsQuery

Page through the physical gifts available to your organization. Filter by category, occasion, search text, price range (in cents) or specific IDs.

query physicalGifts( skip: Int! take: Int! query: PhysicalGiftQuery ): PhysicalGifts!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
query	PhysicalGiftQuery

Returns PhysicalGifts!

physicalGiftQuery

One physical gift by ID, with its products and variants.

query physicalGift( id: ID! ): PhysicalGift

Argument	Type	Description
idrequired	ID!

Returns PhysicalGift

categoriesQuery

Gift categories you can use to filter physicalGifts.

query categories: [Category!]!

Returns [Category!]!

occasionsQuery

Occasions you can use to filter physicalGifts.

query occasions: [Occasion!]!

Returns [Occasion!]!

marketplaceWebGiftsQuery

Search buyable products from retail partners by keyword. Results are cached. Pass excludeUrls to get a fresh page that skips gifts you already showed.

query marketplaceWebGifts( query: String! excludeUrls: [String!] ): [MarketplaceWebGift!]!

Argument	Type	Description
queryrequired	String!
excludeUrls	[String!]

Returns [MarketplaceWebGift!]!

marketplaceWebGiftDetailQuery

Full product details (images, price, variants) for a result from marketplaceWebGifts.

query marketplaceWebGiftDetail( url: String! ): MarketplaceWebGiftDetail

Argument	Type	Description
urlrequired	String!

Returns MarketplaceWebGiftDetail

marketplaceWebGiftImportMutation

Add a marketplaceWebGifts result to your catalog so it can be sent. Pass color or size to import a specific option. Returns the new gift ID.

mutation marketplaceWebGiftImport( input: MarketplaceWebGiftImportInput! ): ProductImportResult!

Argument	Type	Description
inputrequired	MarketplaceWebGiftImportInput!

Returns ProductImportResult!

productImportMutation

Add any product to your catalog from its product page URL, title, price and images. Returns the new gift ID, which you can pass to physicalOrderCreate.

mutation productImport( input: ProductImportInput! ): ProductImportResult!

Argument	Type	Description
inputrequired	ProductImportInput!

Returns ProductImportResult!

digitalBrandsQuery

Gift card brands available for digital campaigns and orders.

query digitalBrands( query: DigitalBrandQuery skip: Int take: Int ): [DigitalBrand!]!

Argument	Type	Description
query	DigitalBrandQuery
skip	Int
take	Int

Returns [DigitalBrand!]!

Gift recommendations

The recommendation engine is a REST endpoint, documented in Gift recommendations. It takes free text about a person and returns ranked gift ideas from the catalog.

Campaigns

A campaign saves gift choices, message templates and settings so orders only need a recipient. Orders can also be sent without a campaign by passing gift IDs directly.

campaignsQueryscope: campaigns:read

Page through physical and digital campaigns together.

query campaigns( skip: Int! take: Int! sort: CampaignSortKey query: CampaignQuery ): Campaigns!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
sort	CampaignSortKey
query	CampaignQuery

Returns Campaigns!

physicalCampaignsQuery

Page through physical gift campaigns.

query physicalCampaigns( skip: Int! take: Int! sort: PhysicalCampaignSortKey query: PhysicalCampaignQuery ): PhysicalCampaigns!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
sort	PhysicalCampaignSortKey
query	PhysicalCampaignQuery

Returns PhysicalCampaigns!

physicalCampaignQuery

One physical campaign by ID.

query physicalCampaign( id: ID! ): PhysicalCampaign

Argument	Type	Description
idrequired	ID!

Returns PhysicalCampaign

physicalCampaignCreateMutationscope: campaigns:write

Create a physical campaign. List several gifts in giftOptions to let recipients choose one, or set sendAll on the order to ship them all together.

mutation physicalCampaignCreate( input: PhysicalCampaignInput! ): PhysicalCampaign!

Argument	Type	Description
inputrequired	PhysicalCampaignInput!

Returns PhysicalCampaign!

physicalCampaignUpdateMutationscope: campaigns:write

Update a physical campaign. Fields you leave out keep their current values.

mutation physicalCampaignUpdate( id: ID! input: PhysicalCampaignInput! ): PhysicalCampaign!

Argument	Type	Description
idrequired	ID!
inputrequired	PhysicalCampaignInput!

Returns PhysicalCampaign!

digitalCampaignsQuery

Page through digital gift card campaigns.

query digitalCampaigns( skip: Int! take: Int! sort: DigitalCampaignSortKey query: DigitalCampaignQuery ): DigitalCampaigns!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
sort	DigitalCampaignSortKey
query	DigitalCampaignQuery

Returns DigitalCampaigns!

digitalCampaignQuery

One digital campaign by ID.

query digitalCampaign( id: ID! ): DigitalCampaign

Argument	Type	Description
idrequired	ID!

Returns DigitalCampaign

digitalCampaignCreateMutationscope: campaigns:write

Create a digital gift card campaign with a set of brands and a reward value.

mutation digitalCampaignCreate( input: DigitalCampaignInput! ): DigitalCampaign!

Argument	Type	Description
inputrequired	DigitalCampaignInput!

Returns DigitalCampaign!

digitalCampaignUpdateMutationscope: campaigns:write

Update a digital campaign. Fields you leave out keep their current values.

mutation digitalCampaignUpdate( id: ID! input: DigitalCampaignInput! ): DigitalCampaign!

Argument	Type	Description
idrequired	ID!
inputrequired	DigitalCampaignInput!

Returns DigitalCampaign!

Physical orders

A physical order ships a gift from the RevSend warehouse, in branded packaging with an optional handwritten note. You can send to an address you already have, or get a claim link the recipient uses to choose their gift and enter their own address.

physicalOrderCreateMutationscope: orders:write

Send a physical gift. Pass campaignId to use a campaign's gifts and templates, or giftIds to send specific gifts without one.

Send to a known address: pass mailingAddress (and validateAddress: true to check it first).

Send a claim link: set recipientSubmitsAddress: true and includeClaimUrl: true. The response includes claimUrl, which you can share in your own email or message. Set sendEmail: false if you do not want RevSend to email the recipient.

Let the recipient choose: pass several gifts and leave sendAll off. Set sendAll: true to ship every gift in one package.

Handwritten note: set includeHandWritten: true and pass the note text in physicalNote. Check that the text fits with physicalOrderHandWritingSample.

mutation physicalOrderCreate( input: PhysicalOrderInput! ): PhysicalOrder!

Argument	Type	Description
inputrequired	PhysicalOrderInput!

Returns PhysicalOrder!

mutation SendGift($input: PhysicalOrderInput!) {
  physicalOrderCreate(input: $input) {
    id
    ref
    claimUrl
    expiresAt
  }
}

# variables
{
  "input": {
    "giftIds": [{ "id": "GIFT_ID" }, { "id": "GIFT_ID_2" }],
    "recipient": { "name": "Jordan Lee", "email": "jordan@example.com", "orgName": "Acme" },
    "message": "Thanks for the great conversation, Jordan.",
    "includeHandWritten": true,
    "physicalNote": "Jordan, enjoy this one. Talk soon!",
    "recipientSubmitsAddress": true,
    "includeClaimUrl": true,
    "sendEmail": false
  }
}

physicalOrderCreateWithImportMutationscope: orders:write

Import a product from an external source and immediately create a physical order to send it. This combines productImport and physicalOrderCreate into a single call.

Use this when your system already picked a product on the web. RevSend buys it, repackages it at the warehouse and ships it with your branding.

mutation physicalOrderCreateWithImport( input: PhysicalOrderWithImportInput! ): PhysicalOrder!

Argument	Type	Description
inputrequired	PhysicalOrderWithImportInput!

Returns PhysicalOrder!

productImportAndSendMutation

Alias for physicalOrderCreateWithImport. Import a product and send it in one call.

mutation productImportAndSend( input: PhysicalOrderWithImportInput! ): PhysicalOrder!

Argument	Type	Description
inputrequired	PhysicalOrderWithImportInput!

Returns PhysicalOrder!

physicalHandwrittenNoteCreateMutationscope: orders:write

Create and send a handwritten note order. Looks up the Branded Handwritten Note gift automatically.

mutation physicalHandwrittenNoteCreate( input: PhysicalHandwrittenNoteInput! ): PhysicalOrder!

Argument	Type	Description
inputrequired	PhysicalHandwrittenNoteInput!

Returns PhysicalOrder!

physicalOrderHandWritingSampleMutation

Preview how note text will be laid out by the handwriting machine. Use it to check that a note fits before you create the order.

mutation physicalOrderHandWritingSample( text: String! ): HandWritingSampleOutput

Argument	Type	Description
textrequired	String!

Returns HandWritingSampleOutput

physicalOrderUpdateMutationscope: orders:write

Change the message, handwritten note or recipient on an order you created or manage. The message cannot change once the order has shipped.

mutation physicalOrderUpdate( input: PhysicalOrderInput! id: ID! ): PhysicalOrder!

Argument	Type	Description
inputrequired	PhysicalOrderInput!
idrequired	ID!

Returns PhysicalOrder!

physicalOrderCancelMutationscope: orders:write

Cancel a physical order you created and refund its cost to the budget it was paid from. Orders that already shipped cannot be cancelled.

mutation physicalOrderCancel( id: ID! ): PhysicalOrder!

Argument	Type	Description
idrequired	ID!

Returns PhysicalOrder!

physicalOrdersQuery

Page through physical orders. A user key sees its own orders; an org admin or team admin key sees the orders it manages. Filter by date range, team or delivery status.

query physicalOrders( skip: Int! take: Int! sort: PhysicalOrderSortKey query: PhysicalOrderQuery ): PhysicalOrders!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
sort	PhysicalOrderSortKey
query	PhysicalOrderQuery

Returns PhysicalOrders!

physicalOrderQuery

One physical order by ID, with its status, claim link, selected gifts and shipping events.

query physicalOrder( id: ID! ): PhysicalOrder

Argument	Type	Description
idrequired	ID!

Returns PhysicalOrder

Bulk physical orders

Send the same gift to many known addresses in one request. Bulk orders run in the background; poll the batch for progress.

physicalOrderBulkCreateMutationscope: orders:write

Queue a batch of physical orders, either from orders rows or from a CSV uploaded with bulkOrderSourceUploadUrl.

mutation physicalOrderBulkCreate( input: PhysicalOrderBulkCreateInput! ): PhysicalOrderBatch!

Argument	Type	Description
inputrequired	PhysicalOrderBulkCreateInput!

Returns PhysicalOrderBatch!

bulkOrderSourceUploadUrlMutation

Get a short-lived upload URL for a recipient CSV. PUT the file to url, then pass key as sourceS3Key to physicalOrderBulkCreate.

mutation bulkOrderSourceUploadUrl: AssetUploadUrl!

Returns AssetUploadUrl!

validatePhysicalOrderCsvQuery

Check a recipient CSV before you upload it. Returns row-level errors.

query validatePhysicalOrderCsv( csvContent: String! ): CSVValidationResult!

Argument	Type	Description
csvContentrequired	String!

Returns CSVValidationResult!

physicalOrderBulkStatusQuery

Progress of a batch you created: accepted, placed, failed and delivered counts.

query physicalOrderBulkStatus( id: ID! ): PhysicalOrderBatch!

Argument	Type	Description
idrequired	ID!

Returns PhysicalOrderBatch!

Digital orders

Digital orders send gift cards by email or by a link you share yourself. Digital rewards can be redeemed in 200+ countries.

digitalOrderCreateMutationscope: orders:write

Send one digital gift card. Use deliveryMethod: LINK with includeClaimUrl: true to share the link yourself.

mutation digitalOrderCreate( input: DigitalOrderInput! ): DigitalOrder!

Argument	Type	Description
inputrequired	DigitalOrderInput!

Returns DigitalOrder!

digitalOrderBulkCreateMutationscope: orders:write

Send a digital campaign to a list of recipients in one request.

mutation digitalOrderBulkCreate( input: DigitalOrderBulkInput! ): DigitalOrderBatch!

Argument	Type	Description
inputrequired	DigitalOrderBulkInput!

Returns DigitalOrderBatch!

digitalOrderCancelMutation

Cancel an unredeemed digital order and refund it to the budget it was paid from.

mutation digitalOrderCancel( id: ID! ): DigitalOrder!

Argument	Type	Description
idrequired	ID!

Returns DigitalOrder!

digitalOrdersQuery

Page through digital orders. A user key sees its own orders; an admin key sees the orders it manages.

query digitalOrders( skip: Int! take: Int! sort: DigitalOrderSortKey query: DigitalOrderQuery ): DigitalOrders!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
sort	DigitalOrderSortKey
query	DigitalOrderQuery

Returns DigitalOrders!

digitalOrderQuery

One digital order by its ref.

query digitalOrder( orderRef: ID! ): DigitalOrder

Argument	Type	Description
orderRefrequired	ID!

Returns DigitalOrder

digitalOrderBatchesQuery

Page through bulk digital sends.

query digitalOrderBatches( skip: Int! take: Int! sort: DigitalOrderBatchSortKey query: DigitalOrderBatchQuery ): DigitalOrderBatches!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
sort	DigitalOrderBatchSortKey
query	DigitalOrderBatchQuery

Returns DigitalOrderBatches!

digitalOrderBatchQuery

One bulk digital send by its ref.

query digitalOrderBatch( orderBatchRef: ID! ): DigitalOrderBatch

Argument	Type	Description
orderBatchRefrequired	ID!

Returns DigitalOrderBatch

Order history

Physical and digital orders in one list, for reporting.

ordersQueryscope: orders:read

Page through physical and digital orders together, newest first. Filter by date range, type, team or search text.

query orders( skip: Int! take: Int! sort: OrderSortKey myOrders: Boolean getAll: Boolean query: OrderQuery ): Orders!

Argument	Type	Description
skiprequired	Int!
takerequired	Int!
sort	OrderSortKey
myOrders	Boolean
getAll	Boolean
query	OrderQuery

Returns Orders!

ordersCsvCreateMutationscope: orders:read

Export order history as CSV. Returns the CSV text.

mutation ordersCsvCreate( query: OrderQuery myOrders: Boolean sort: OrderSortKey ): String!

Argument	Type	Description
query	OrderQuery
myOrders	Boolean
sort	OrderSortKey

Returns String!

Branding

Brand templates control the logo, colors and handwriting style on claim pages, emails and notes. Create one per brand you send for and pass its ID as brandTemplateId on orders and campaigns. Creating and editing templates needs an org admin or team admin key.

orgBrandTemplatesQuery

Brand templates in your organization.

query orgBrandTemplates: [OrgBrandTemplate!]!

Returns [OrgBrandTemplate!]!

orgBrandTemplateCreateMutation

Create a brand template. Upload the logo first with assetUploadUrlCreate and pass the resulting URL as logoUrl.

mutation orgBrandTemplateCreate( input: OrgBrandTemplateInput! ): OrgBrandTemplate!

Argument	Type	Description
inputrequired	OrgBrandTemplateInput!

Returns OrgBrandTemplate!

orgBrandTemplateUpdateMutation

Update a brand template.

mutation orgBrandTemplateUpdate( id: ID! input: OrgBrandTemplateInput! ): OrgBrandTemplate!

Argument	Type	Description
idrequired	ID!
inputrequired	OrgBrandTemplateInput!

Returns OrgBrandTemplate!

orgBrandTemplateDeleteMutation

Delete a brand template.

mutation orgBrandTemplateDelete( id: ID! ): Boolean!

Argument	Type	Description
idrequired	ID!

Returns Boolean!

orgSetDefaultBrandTemplateMutation

Make a template the default for orders that do not pass brandTemplateId.

mutation orgSetDefaultBrandTemplate( id: ID! ): Org!

Argument	Type	Description
idrequired	ID!

Returns Org!

assetUploadUrlCreateMutation

Get a short-lived upload URL for an image such as a logo. PUT the file to url with the same contentType.

mutation assetUploadUrlCreate( input: AssetUploadUrlInput! ): AssetUploadUrl

Argument	Type	Description
inputrequired	AssetUploadUrlInput!

Returns AssetUploadUrl

Webhooks

integrationWebhookCreateMutation

mutation integrationWebhookCreate( input: WebhookCreateInput! ): WebhookCreateResponse!

Argument	Type	Description
inputrequired	WebhookCreateInput!

Returns WebhookCreateResponse!

integrationWebhookDeleteMutation

Remove a webhook by the ID returned from integrationWebhookCreate.

mutation integrationWebhookDelete( input: WebhookDeleteInput! ): String!

Argument	Type	Description
inputrequired	WebhookDeleteInput!

Returns String!

integrationWebhookSampleQuery

A sample event payload, useful for building and testing your handler.

query integrationWebhookSample: WebhookSampleResponse

Returns WebhookSampleResponse

Types

Objects, inputs and enums used by the operations above. Fields used only inside RevSend are left out.

AssetUploadUrlobject

Field	Type	Description
url	String!
key	String!

AssetUploadUrlInputinput

Field	Type	Description
contentTyperequired	String!

Budgetobject

Field	Type	Description
id	ID!
amount	Float!
isPaymentFallbackEnabled	Boolean!
refillAmount	Int!
isRollover	Boolean!
alertEnabled	Boolean!
alertThresholdAmount	Int
alertRecipientEmail	String
alertLastSentAt	DateTime
alertActive	Boolean!

Campaignobject

Field	Type	Description
id	ID!
ref	String!
createdAt	DateTime!
type	CampaignType!
name	String
brands	[DigitalBrand]
gifts	[PhysicalGift]

CampaignQueryinput

Field	Type	Description
createdAtMin	DateTime
createdAtMax	DateTime
isArchived	Boolean
teamId	String
type	CampaignType
text	String
isRevSendCurated	Boolean

Campaignsobject

Field	Type	Description
totalCount	Int!
nodes	[Campaign!]!

CampaignSortKeyenum

Value	Description
CREATED_AT_ASC
CREATED_AT_DESC

CampaignTypeenum

Value	Description
DIGITAL
PHYSICAL

Categoryobject

Field	Type	Description
id	ID!
name	String!
icon	String!

CSVValidationErrorobject

A validation error found in the CSV

Field	Type	Description
rowNumber	Int!	The row number where the error was found (1-indexed, including header)
field	String!	The field/column where the error was found
message	String!	Description of the error
value	String	The actual value that caused the error (if applicable)

CSVValidationResultobject

Result of CSV validation for physical orders

Field	Type	Description
isValid	Boolean!	Whether the entire CSV is valid (no errors)
totalRows	Int!	Total number of rows in the CSV (excluding header)
validRows	Int!	Number of rows with valid data and addresses
errors	[CSVValidationError!]!	List of validation errors found in the CSV
summary	CSVValidationSummary!	Summary of validation results

CSVValidationSummaryobject

Summary of CSV validation results

Field	Type	Description
missingFields	Int!	Number of rows with missing required fields
invalidAddresses	Int!	Number of rows with invalid addresses
validAddresses	Int!	Number of rows with valid addresses

Currencyenum

Value	Description
USD
CAD

DateTimescalar

DigitalBrandobject

Digital reward brand

Field	Type	Description
id	ID!
name	String!
iconUrl	String
faceplateUrl	String	For displaying the card image
legalTerms	String
description	String
availableCountries	String
supportedCharities	String
redemptionDisclaimer	String
redemptionMethods	[String!]
denominations	[Int!]	The possible values, in cents, that the card can be redeemed for. A null value means the possible redemption values are defined by the increment.
increment	Int	The valid redemption increment, in cents. A null value means the possible redemption values are defined by the denominations.
maxValue	Int!	Max redemption value of the card, in cents
minValue	Int!	Min redemption value of the card, in cents
currency	Currency!	Denominated currency for this brand
isFavorite	Boolean	Is this brand a favorite of the user
isNonRedeemable	Boolean	When true, claiming this brand marks the gift redeemed without issuing a gift card

DigitalBrandQueryinput

Field	Type	Description
search	String
category	ID
occasion	ID
international	Boolean
minPrice	Int	Minimum card value in dollars
maxPrice	Int	Maximum card value in dollars

DigitalCampaignobject

Field	Type	Description
id	ID!
createdAt	DateTime!
ref	String!
name	String!
rewardValue	Int!
brands	[ID!]!
brandDetails	[DigitalBrand]
messageTemplate	String
headlineTemplate	String
allowCharity	Boolean!
brandsSummary	String
isArchived	Boolean!
requireEmail	Boolean
currency	Currency
team	Team
private	Boolean!
requireBookedMeeting	Boolean!
autoExpirationDays	Int
brandTemplateId	ID

DigitalCampaignInputinput

Field	Type	Description
name	String
messageTemplate	String
headlineTemplate	String
brands	[ID!]
rewardValue	Int
currency	Currency
allowCharity	Boolean
isArchived	Boolean
team	String
private	Boolean
requireBookedMeeting	Boolean
autoExpirationDays	Int
brandTemplateId	ID

DigitalCampaignQueryinput

Field	Type	Description
creatorEmail	String
createdAtMin	DateTime
createdAtMax	DateTime
rewardValueMin	Int
rewardValueMax	Int
isArchived	Boolean
currency	Currency

DigitalCampaignsobject

Field	Type	Description
totalCount	Int!
nodes	[DigitalCampaign!]!

DigitalCampaignSortKeyenum

Value	Description
CREATED_AT_ASC
CREATED_AT_DESC

DigitalOrderobject

Field	Type	Description
id	ID!
ref	String!
createdAt	DateTime!
rewardValue	Int!
status	DigitalOrderStatus!
rewardLink	String!
claimUrl	String	Recipient claim URL. Populated on create when includeClaimUrl is true and deliveryMethod is LINK.
recipient	Recipient!
creator	User!
campaign	DigitalCampaign
description	String
deliveryMethod	DigitalOrderDeliveryMethod!
events	[DigitalOrderEvent!]!
cancelledAt	DateTime
expiresAt	DateTime
teamId	String
hideExpirationWarning	Boolean
requireBookedMeeting	Boolean
notificationEmails	String	Comma-separated extra emails notified on order status events, in addition to the creator.

DigitalOrderBatchobject

Field	Type	Description
id	ID!
ref	String!
creator	User!
createdAt	DateTime!
totalOrders	Int!
totalDelivered	Int!
totalPaid	Int!
digitalOrders	DigitalOrders!

DigitalOrderBatchesobject

Field	Type	Description
totalCount	Int!
nodes	[DigitalOrderBatch!]!

DigitalOrderBatchQueryinput

Field	Type	Description
createdAtMin	DateTime
createdAtMax	DateTime
teamId	String

DigitalOrderBatchSortKeyenum

Value	Description
CREATED_AT_ASC
CREATED_AT_DESC

DigitalOrderBulkInputinput

Field	Type	Description
recipientsrequired	[RecipientInput!]!
campaignIdrequired	ID!
messageTemplaterequired	String!
headlineTemplate	String
deliveryMethod	DigitalOrderDeliveryMethod
requireBookedMeeting	Boolean	When true, the recipient can claim only after a meeting with the sender was ever scheduled. Cancelling the meeting does not lock the gift again. Defaults to the campaign setting when omitted.
notificationEmails	String	Comma-separated extra emails to notify on order status events for every order in the batch. The order creator is always notified; these addresses are added in addition.

DigitalOrderDeliveryMethodenum

Value	Description
LINK
EMAIL

DigitalOrderEventobject

Field	Type	Description
id	ID!
createdAt	DateTime!
code	DigitalOrderEventCode!

DigitalOrderEventCodeenum

Value	Description
CREATED
DELIVERED
VIEWED
PAYMENT_SUCCEEDED
REWARD_EMAIL_FAILED
REWARD_EMAIL_SUCCEEDED
EMAIL_OPENED
REDEEMED

DigitalOrderInputinput

Field	Type	Description
recipientrequired	RecipientInput!
campaignId	ID
brandId	ID
brandTemplateId	ID
currencyId	ID
rewardValue	Int
messageTemplate	String
headlineTemplate	String
deliveryMethodrequired	DigitalOrderDeliveryMethod!
includeClaimUrl	Boolean	When true, include the recipient claim URL on the returned order.
requireBookedMeeting	Boolean	When true, the recipient can claim only after a meeting with the sender was ever scheduled. Cancelling the meeting does not lock the gift again. Defaults to the campaign setting when omitted.
notificationEmails	String	Comma-separated extra emails to notify on order status events (viewed, redeemed, etc.). The order creator is always notified; these addresses are added in addition.

DigitalOrderQueryinput

Field	Type	Description
createdAtMin	DateTime
createdAtMax	DateTime
teamId	String

DigitalOrdersobject

Field	Type	Description
totalCount	Int!
nodes	[DigitalOrder!]!

DigitalOrderSortKeyenum

Value	Description
CREATED_AT_ASC
CREATED_AT_DESC

DigitalOrderStatusenum

Value	Description
PAYMENT_PENDING
PAYMENT_SUCCEEDED
REVOKED

FulfillmentEventobject

A shipping status update at a point in time.

Field	Type	Description
happenedAt	DateTime!	The time at which this fulfillment event happened.
id	ID!	A globally-unique identifier.
message	String	A message associated with this fulfillment event.
status	FulfillmentEventStatus!	The status of this fulfillment event.

FulfillmentEventStatusenum

Shipping status reported by the carrier.

Value	Description
LABEL_PURCHASED	A shipping label has been purchased.
LABEL_PRINTED	A purchased shipping label has been printed.
READY_FOR_PICKUP	The fulfillment is ready to be picked up.
CONFIRMED	The fulfillment is confirmed. This is the default value when no other information is available.
IN_TRANSIT	The fulfillment is in transit.
OUT_FOR_DELIVERY	The fulfillment is out for delivery.
ATTEMPTED_DELIVERY	A delivery was attempted.
DELIVERED	The fulfillment was successfully delivered.
FAILURE	The fulfillment request failed.
DELAYED	The fulfillment was delayed.

GiftQuantitiesinput

Field	Type	Description
idrequired	ID!
quantity	Int
variantId	ID

GiftQuantityInputinput

Input for specifying gift quantities

Field	Type	Description
giftIdrequired	ID!	Gift ID
quantity	Int	Quantity of this gift
variantId	ID	Product variant ID (optional)

HandwritingFontStyleenum

Value	Description
CLEAN
MESSY

HandWritingSampleOutputobject

Field	Type	Description
outputText	String!

Imageobject

Represents an image resource.

Field	Type	Description
altText	String	A word or phrase to share the nature or contents of an image.
height	Int	Original height of the image in pixels, when known.
id	ID	A unique identifier for the image.
url	String!	The location of the image as a URL. If no transform options are specified, then the original image will be preserved including any pre-applied transforms. All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. If you need multiple variations of the same image, then you can use GraphQL aliases.
width	Int	Original width of the image in pixels, when known.

IntegrationPartnersenum

Value	Description
MAKE
ZAPIER
VIA_SOCKET

InvoiceItemobject

Field	Type	Description
id	ID!
createdAt	DateTime!
amount	Int!
description	String

JSONscalar

MailingAddressInputinput

A mailing address. countryCode is ISO 3166-1 alpha-2 and provinceCode is the state or province code.

Field	Type	Description
address1	String	The first line of the address. Typically the street address or PO Box number.
address2	String	The second line of the address. Typically the number of the apartment, suite, or unit.
city	String	The name of the city, district, village, or town.
company	String	The name of the customer's company or organization.
countryCode	String	The two-letter code for the country of the address.
firstName	String	The first name of the customer.
lastName	String	The last name of the customer.
phone	String	A unique phone number for the customer. Formatted using E.164 standard. For example, _+16135551111_.
provinceCode	String	The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
zip	String	The zip or postal code of the address.

MarketplaceWebGiftobject

Field	Type	Description
id	ID!
title	String!
url	String!
source	String!
imageUrl	String
price	Float
snippet	String

MarketplaceWebGiftDetailobject

Field	Type	Description
url	String!
title	String!
description	String
price	Float
source	String!
images	[String!]!
variants	[MarketplaceWebGiftVariant!]!

MarketplaceWebGiftImportInputinput

Field	Type	Description
urlrequired	String!	Product URL from a `marketplaceWebGifts` result.
title	String
source	String
imageUrl	String
price	Float
query	String	The search text that found this product. Helps pick the right option when a color or size was requested.
color	String	Color option to import, when the product has several.
size	String	Size option to import, when the product has several.

MarketplaceWebGiftVariantobject

Field	Type	Description
title	String!
price	Float
imageUrl	String
color	String
size	String

MeetingClaimGateobject

Field	Type	Description
requireBookedMeeting	Boolean!
isSatisfied	Boolean!
hasAssociatedMeeting	Boolean!
meetingEndsAt	DateTime
creatorBookingLink	String
creatorName	String

NotePaperSizeenum

Sheet a handwritten note is plotted on. CARD_5X7 is the current 5x7 card.

Value	Description
CARD_5X7
A6
A5
A4
A3
B5
B4
US_LETTER
ENVELOPE_10

NotificationSettingsobject

Field	Type	Description
emailAddressSubmittedEnabled	Boolean!
emailShippedEnabled	Boolean!
emailDeliveredEnabled	Boolean!
emailViewedEnabled	Boolean!
emailRedeemedEnabled	Boolean!
slackAddressSubmittedEnabled	Boolean!
slackShippedEnabled	Boolean!
slackDeliveredEnabled	Boolean!
slackViewedEnabled	Boolean!
slackRedeemedEnabled	Boolean!

Occasionobject

Field	Type	Description
id	ID!
name	String!
icon	String!

Orderobject

Field	Type	Description
id	ID!
ref	String!
createdAt	DateTime!
creatorName	String
creatorOrg	String
recipientName	String
recipientOrg	String
recipientSubmitsAddress	Boolean
addressConfirmedDate	DateTime
events	[DigitalOrderEvent!]
fulfillmentEvents	[FulfillmentEvent!]
type	OrderType!
totalCost	Int!
description	String
cancelledAt	DateTime
recipientLinkViewedAt	DateTime

OrderQueryinput

Field	Type	Description
createdAtMin	DateTime
createdAtMax	DateTime
type	OrderType
teamId	String
search	String
creatorId	ID
orgId	ID

Ordersobject

Field	Type	Description
totalCount	Int!
nodes	[Order!]!

OrderSampleOrderobject

Field	Type	Description
id	String!
value	Int!
message	String!
emailSubject	String!
deliveryMethod	String!
status	String!

OrderSampleRecipientobject

Field	Type	Description
name	String!
email	String
orgName	String!

OrderSampleSenderobject

Field	Type	Description
id	String!
email	String!
name	String!
teamId	String!
teamName	String!

OrderSortKeyenum

Value	Description
CREATED_AT_ASC
CREATED_AT_DESC

OrderTypeenum

Value	Description
DIGITAL
PHYSICAL

Orgobject

Field	Type	Description
id	ID!
name	String!
formattedName	String!
logoUrl	String
logoBackgroundColor	String
logoPrimaryColor	String
defaultBrandTemplateId	ID
defaultBrandTemplate	OrgBrandTemplate
brandTemplates	[OrgBrandTemplate!]!
isInternational	Boolean
budgetAlertDefaultThreshold	Int!

OrgBrandingobject

Field	Type	Description
logoUrl	String
logoBackgroundColor	String
logoPrimaryColor	String

OrgBrandTemplateobject

Field	Type	Description
id	ID!
name	String!
logoUrl	String
logoBackgroundColor	String
logoPrimaryColor	String
handwritingFontStyle	HandwritingFontStyle!
isDefault	Boolean!

OrgBrandTemplateInputinput

Field	Type	Description
namerequired	String!
logoUrl	String
logoBackgroundColor	String
logoPrimaryColor	String
handwritingFontStyle	HandwritingFontStyle

PhysicalCampaignobject

Field	Type	Description
id	ID!
ref	String!
createdAt	DateTime!
name	String!
gifts	[PhysicalGift!]!
variants	[ID!]
messageTemplate	String
physicalNoteTemplate	String
notePaperSize	NotePaperSize	Sheet notes from this campaign are plotted on. Orders that omit a size copy this. Defaults to the 5x7 card. The line limit follows this size.
team	Team
private	Boolean!
requireBookedMeeting	Boolean!
autoExpirationDays	Int
brandTemplateId	ID

PhysicalCampaignInputinput

Field	Type	Description
name	String
messageTemplate	String
physicalNoteTemplate	String
notePaperSize	NotePaperSize	Sheet notes from this campaign are plotted on. Orders that omit a size copy this. Defaults to the 5x7 card. The line limit follows this size.
giftOptions	[GiftQuantities!]
replaceGifts	Boolean
isArchived	Boolean
isOneOff	Boolean
private	Boolean
requireBookedMeeting	Boolean
autoExpirationDays	Int
team	String
brandTemplateId	ID

PhysicalCampaignQueryinput

Field	Type	Description
createdAtMin	DateTime
createdAtMax	DateTime
isArchived	Boolean

PhysicalCampaignsobject

Field	Type	Description
totalCount	Int!
nodes	[PhysicalCampaign!]!

PhysicalCampaignSortKeyenum

Value	Description
CREATED_AT_ASC
CREATED_AT_DESC

PhysicalGiftobject

Field	Type	Description
id	ID!
title	String!
messageMaxLength	Int
messageMaxLines	Int
descriptionHtml	String
featuredImageSrc	String
products	[Product!]!
productVariants	[ProductVariant!]!
isDisabled	Boolean
categories	[String!]!
occasions	[String!]!
isAddOn	Boolean
requiresPhone	Boolean
isFavorite	Boolean
selectedVariant	ProductVariant
optionId	ID

PhysicalGiftQueryinput

Field	Type	Description
category	String
occasion	String
search	String
addOns	Boolean
ids	[String!]
minPrice	Int	Minimum gift price in dollars, including shipping
maxPrice	Int	Maximum gift price in dollars, including shipping

PhysicalGiftsobject

Field	Type	Description
totalCount	Int
nodes	[PhysicalGift!]!

PhysicalHandwrittenNoteInputinput

Input for creating a handwritten note-only order.

Field	Type	Description
recipientrequired	RecipientInput!	The recipient information for this order.
physicalNoterequired	String!	The message that will be physically printed on the handwritten note.
notePaperSize	NotePaperSize	Sheet the handwritten note is plotted on. Omit to use the 5x7 card. The line limit follows this size.
message	String	Optional email message sent to the recipient.
mailingAddressrequired	MailingAddressInput!	The mailing address for the recipient.
sendEmail	Boolean	Whether to send the reward link immediately through email or if the user will share the link themselves.
headlineTemplate	String	Subject line if sending email.
validateAddress	Boolean	Check the mailing address before the order is placed and reject it if it cannot be delivered.
brandTemplateId	ID
notificationEmails	String	Comma-separated extra emails to notify on order status events (shipped, delivered, viewed, etc.). The order creator is always notified; these addresses are added in addition.

PhysicalOrderobject

Field	Type	Description
id	ID!
ref	String!
createdAt	DateTime!
recipient	Recipient!
isAddressConfirmed	Boolean
addressConfirmedDate	DateTime
recipientSubmitsAddress	Boolean
creatorName	String!
creatorEmail	String!
orgName	String!
orgBranding	OrgBranding!
message	String!
physicalNote	String!
notePaperSize	NotePaperSize!	Sheet the handwritten note is plotted on. Defaults to the 5x7 card.
invoiceItems	[InvoiceItem!]!
description	String
trackingUrl	String
gifts	[PhysicalGift!]
sendAll	Boolean
campaign	PhysicalCampaign
fulfillmentEvents	[FulfillmentEvent!]!
images	[Image!]!
giftChoices	[PhysicalGift!]!
selectedGifts	[PhysicalGift!]
hideContents	Boolean
hideExpirationWarning	Boolean
requireBookedMeeting	Boolean
meetingClaimGate	MeetingClaimGate
cancelledAt	DateTime
needsToSelectGift	Boolean
includeHandwritten	Boolean
fontStyle	HandwritingFontStyle!
expiresAt	DateTime
isExpired	Boolean
recipientLinkViewedAt	DateTime
claimUrl	String	Recipient claim URL. Populated on create when includeClaimUrl is true and the recipient must submit their address.
notificationEmails	String	Comma-separated extra emails notified on order status events, in addition to the creator.

PhysicalOrderBatchobject

Field	Type	Description
id	ID!
ref	String!
creator	User!
createdAt	DateTime!
status	String!
acceptedCount	Int!
placedCount	Int!
errorCount	Int!
totalOrders	Int!
totalDelivered	Int!
totalPaid	Int!

PhysicalOrderBulkCreateInputinput

Input for bulk creating physical orders from CSV data

Field	Type	Description
sourceS3Key	String	S3 key from bulkOrderSourceUploadUrl. Required for more than 100 rows.
orders	[PhysicalOrderBulkItemInput!]	Inline rows. Limited to 100. Prefer sourceS3Key for large batches.
campaignId	ID	Campaign ID to use for all orders (mutually exclusive with giftQuantities)
giftQuantities	[GiftQuantityInput!]	Array of gift quantities to use for all orders (mutually exclusive with campaignId)
sendAll	Boolean	Whether to send all gifts in the campaign to each recipient
hideContents	Boolean	Hide gift/package details during redemption and show a surprise screen instead. Only valid when recipient selection is not required.
sendEmail	Boolean	Whether to send email notifications to recipients
headlineTemplate	String	Subject line template for emails
validateAddress	Boolean	Whether to validate addresses before creating orders
includeHandWritten	Boolean	Whether to include handwritten notes
notePaperSize	NotePaperSize	Sheet every note in this batch is plotted on, unless a row sets its own size. Omit to copy the campaign size, then the 5x7 card. The line limit follows this size.
brandTemplateId	ID
notificationEmails	String	Comma-separated extra emails to notify on order status events for every order in the batch. The order creator is always notified; these addresses are added in addition.

PhysicalOrderBulkItemInputinput

Input for a single order in bulk creation

Field	Type	Description
recipientNamerequired	String!	Recipient name
recipientOrganizationrequired	String!	Recipient organization
handwrittenMessagerequired	String!	Handwritten message for the recipient
notePaperSize	NotePaperSize	Sheet this note is plotted on. Omit to use the batch or campaign size, then the 5x7 card.
address1required	String!	First line of address
address2	String	Second line of address (optional)
cityrequired	String!	City
staterequired	String!	State/Province
postalCoderequired	String!	Postal/ZIP code
countryrequired	String!	Country

PhysicalOrderDeliveryStatusenum

Value	Description
ALL
DELIVERED
PROCESSING
ADDRESS_REQUESTED
VIEWED
SHIPPED
CANCELLED
NOT_DELIVERED

PhysicalOrderInputinput

Field	Type	Description
giftIds	[GiftQuantities!]	The IDs of the gifts for this order. Multiple gift ids can be provided if not from campaign.
campaignId	ID	The ID of the specific campaign for this order. One of giftId or campaignId must be provided. If a campaing is provided, the giftId will be determined by the campaign when the recipients chooses a gift from that campaign.
sendAll	Boolean	If true, all gifts in a campaign will be sent to the recipient.
hideContents	Boolean	Hide gift/package details during redemption and show a surprise screen instead. Only valid when recipient selection is not required.
requireBookedMeeting	Boolean	When true, the recipient can claim only after a meeting with the sender was ever scheduled. Cancelling the meeting does not lock the gift again. Defaults to the campaign setting when omitted.
recipient	RecipientInput	The recipient information for this order.
message	String	The message that the recipient will receive with the gift.
physicalNote	String	This message will be physically printed on a card.
notePaperSize	NotePaperSize	Sheet the handwritten note is plotted on. Omit to copy the campaign size, then the 5x7 card. The line limit follows this size.
recipientSubmitsAddress	Boolean	Indicates whether the recipient will submit their mailing address. If false, the mailing address must be provided by the creator.
mailingAddress	MailingAddressInput	The mailing address for the recipient.
sendEmail	Boolean	Whether to send the reward link immediately through email or if the user will share the link themselves
headlineTemplate	String	Subject line if sending email
validateAddress	Boolean	Check the mailing address before the order is placed and reject it if it cannot be delivered.
includeHandWritten	Boolean	Should this order explicitly include a handwritten note
brandTemplateId	ID
includeClaimUrl	Boolean	When true, include the recipient claim URL on the returned order.
notificationEmails	String	Comma-separated extra emails to notify on order status events (shipped, delivered, viewed, etc.). The order creator is always notified; these addresses are added in addition.

PhysicalOrderQueryinput

Field	Type	Description
createdAtMin	DateTime
createdAtMax	DateTime
deliveryStatus	PhysicalOrderDeliveryStatus
teamId	String
isDelivered	Boolean

PhysicalOrdersobject

Field	Type	Description
totalCount	Int!
nodes	[PhysicalOrder!]!

PhysicalOrderSortKeyenum

Value	Description
CREATED_AT_ASC
CREATED_AT_DESC
PO_NUMBER_ASC

PhysicalOrderWithImportInputinput

Input for importing a product and creating an order in a single call. Combines ProductImportInput and PhysicalOrderInput fields.

Field	Type	Description
titlerequired	String!	The name/title of the product.
price	Float	Product price in US dollars, for example `29.99`. Pass `price` or `priceCents`.
priceCents	Int	Product price in cents, for example `2999`. Pass `price` or `priceCents`.
imagesrequired	[String!]!	Array of image URLs for the product. The first image will be used as the featured image.
sourcerequired	String!	Where the product comes from, for example `amazon` or the store name from a recommendation.
purchaseUrlrequired	String!	Product page URL where RevSend will buy the item.
shortenTitle	Boolean	Clean up long retail titles. Default: true.
categoryIds	[String!]	Category IDs to associate with the created gift.
occasionIds	[String!]	Occasion IDs to associate with the created gift.
recipientrequired	RecipientInput!	The recipient information for this order.
message	String	The message that the recipient will receive with the gift.
physicalNote	String	This message will be physically printed on a card.
notePaperSize	NotePaperSize	Sheet the handwritten note is plotted on. Omit to use the 5x7 card. The line limit follows this size.
recipientSubmitsAddress	Boolean	Indicates whether the recipient will submit their mailing address. If false, the mailing address must be provided by the creator.
mailingAddress	MailingAddressInput	The mailing address for the recipient.
sendEmail	Boolean	Whether to send the reward link immediately through email or if the user will share the link themselves.
headlineTemplate	String	Subject line if sending email.
validateAddress	Boolean	Check the mailing address before the order is placed and reject it if it cannot be delivered.
includeHandWritten	Boolean	Should this order explicitly include a handwritten note.
hideContents	Boolean	Hide gift/package details during redemption and show a surprise screen instead. Only valid when recipient selection is not required.
brandTemplateId	ID
saveToFavorites	Boolean	Whether to immediately save the gift to the current user's favorites. Default: false
includeClaimUrl	Boolean	When true, include the recipient claim URL on the returned order.
notificationEmails	String	Comma-separated extra emails to notify on order status events (shipped, delivered, viewed, etc.). The order creator is always notified; these addresses are added in addition.

Productobject

A product in the catalog, with its images and variants.

Field	Type	Description
id	ID!	Globally unique identifier.
title	String	A product is an addon if it doesn't belong to a single gift, but can be added on to gifts. E.g. special wrapping paper, or a custom printed card.
isAddon	Boolean
images	[Image!]!	A list of images associated with this product
variants	[ProductVariant!]	A list of variants associated with the product.
totalInventory	Int	Inventory level for item in warehouse

ProductImportInputinput

Input for importing a product from an external source.

Field	Type	Description
titlerequired	String!	The name/title of the product.
price	Float	Product price in US dollars, for example `29.99`. Pass `price` or `priceCents`.
priceCents	Int	Product price in cents, for example `2999`. Pass `price` or `priceCents`.
imagesrequired	[String!]!	Array of image URLs for the product. The first image will be used as the featured image.
sourcerequired	String!	Where the product comes from, for example `amazon` or the store name from a recommendation.
purchaseUrlrequired	String!	Product page URL where RevSend will buy the item.
shortenTitle	Boolean	Clean up long retail titles. Default: true.
categoryIds	[String!]	Category IDs to associate with the created gift.
occasionIds	[String!]	Occasion IDs to associate with the created gift.
saveToFavorites	Boolean	Whether to immediately save the gift to the current user's favorites. Default: false
variants	[ProductImportVariantInput!]	Product variants such as sizes or colors, so the sender or recipient can choose one. Up to 20.

ProductImportResultobject

Result returned after successfully importing a product.

Field	Type	Description
giftId	ID!	The created PhysicalGift ID. Use this ID to add the gift to campaigns or create orders.
productId	ID!	ID of the created product.
variantId	ID!	The default ProductVariant ID.
title	String!	The final title (may be shortened if shortenTitle was true).
priceCents	Int!	Final gift price in cents.
imageUrl	String	The URL of the featured image, if available.
variants	[ProductImportVariantResult!]!	Created variants. Includes the default variant when none were supplied.

ProductImportVariantInputinput

Field	Type	Description
titlerequired	String!	Variant title shown to the sender/recipient (e.g. "M" or "Medium / Navy").
price	Float	Variant price in dollars. Defaults to the product price.
optionValues	JSON	Option map, for example `{"Size": "M", "Color": "Navy"}`.

ProductImportVariantResultobject

Field	Type	Description
id	ID!
title	String!

ProductVariantobject

Represents a product variant.

Field	Type	Description
id	ID!	Globally unique identifier.
price	Int!	Price, in cents
images	[Image!]	A list of images associated with this product variant
title	String	The title of the product variant
available	Boolean!	False when the variant is no longer sold. Past orders can still reference it.

Recipientobject

Field	Type	Description
id	ID!
org	Org
email	String
name	String!
orgName	String

RecipientInputinput

Field	Type	Description
email	String
namerequired	String!
orgName	String

Roleenum

Value	Description
ADMIN
USER

Teamobject

Field	Type	Description
id	ID!
name	String!
isAdmin	Boolean!

Userobject

Field	Type	Description
id	ID!
name	String!
email	String!
role	Role!
budget	Budget
teams	[UserTeams]
status	UserStatus!
budgetReminderEnabled	Boolean
shippingUpdatesEnabled	Boolean
notificationSettings	NotificationSettings
bookingLink	String
jobTitle	String
phone	String
createdAt	DateTime
lastActive	DateTime

UserStatusenum

Value	Description
ACTIVE
INACTIVE
INVITED

UserTeamsobject

Field	Type	Description
userId	String!
teamId	String!
name	String!
isAdmin	Boolean!

WebhookCreateInputinput

Field	Type	Description
urlrequired	String!
sourcerequired	IntegrationPartners!	Label for the tool that registered the webhook. It does not change delivery; any value works.
typerequired	WebhookTypes!

WebhookCreateResponseobject

Field	Type	Description
id	String!

WebhookDeleteInputinput

Field	Type	Description
idrequired	String!

WebhookSampleResponseobject

Field	Type	Description
order	OrderSampleOrder!
recipient	OrderSampleRecipient!
sender	OrderSampleSender!

WebhookTypesenum

Value	Description
ORDER_STATUS_UPDATE
ORDER_CREATE

RevSend API

Getting started

Your first request

Authentication

Scopes

Common tasks

Send a gift link

Ship to an address you already have

Let the recipient choose

Recommend a gift, then send it

Track an order

Send under your customer's brand

Gift recommendations

Webhook events

ORDER_CREATE

ORDER_STATUS_UPDATE

Errors

Rate limits

Account

Gift catalog

Gift recommendations

Campaigns

Physical orders

Bulk physical orders

Digital orders

Order history

Branding

Webhooks

Types