Create gift card.

post

https://api.wrappedgiftcards.com/api/GiftCard/Create

If Code is omitted, one is auto-generated. If UniqueId is supplied, a repeat call with the same value is rejected — use it as an idempotency key.

Email delivery is controlled by two flags:

ShouldSendNotification=true alone sends the standard "gift card issued/updated" email.
ShouldSendNotification=true plus SendAsGift=true sends the "gifted" email instead — framed as "from BuyerName to RecipientName" and including GiftMessage. Requires BuyerName and RecipientName to be set. Optionally set GiftScheduledForUtc to schedule delivery for a future time.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The gift card to create.

Create-gift-card request.

code

string | null

Optional pre-assigned code. Omit to auto-generate.

balance

double

Face value in the account's currency.

recipientName

string | null

Recipient name.

recipientEmailAddress

string | null

Recipient email address.

expiresAtUtc

date-time | null

Optional UTC expiry date. If omitted, the account default (if any) is applied.

shouldSendNotification

boolean

Send the delivery email and notify connected sales channels.

notes

string | null

Optional internal note.

buyerName

string | null

Buyer name.

buyerEmailAddress

string | null

Buyer email address.

giftMessage

string | null

Gift message from the buyer to the recipient.

uniqueId

string | null

Idempotency key. Retries with the same value are rejected.

isPromotional

boolean

Mark the card as promotional (e.g. a giveaway).

customField1

string | null

Caller-supplied metadata, echoed unchanged.

customField2

string | null

Caller-supplied metadata, echoed unchanged.

customField3

string | null

Caller-supplied metadata, echoed unchanged.

disableEmails

boolean

Suppress notification emails for this card.

sendAsGift

boolean

Send the "gifted" email template (framed as "from BuyerName to RecipientName") instead of the standard "issued/updated" template. Requires ShouldSendNotification=true, BuyerName and RecipientName. Uses GiftMessage for the email body.

giftScheduledForUtc

date-time | null

Optional UTC time to schedule the gifted email for. Only honoured when SendAsGift=true. If null or in the past, the email is sent immediately.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

`Code` or `UniqueId`, or `SendAsGift` was set without the required fields.

200The created gift card.

400Duplicate Code or UniqueId, or SendAsGift was set without the required fields.

401Missing or invalid x-api-key.

404Account not found.

`Code` or `UniqueId`, or `SendAsGift` was set without the required fields.

`x-api-key`.