GiftCardRequest

gift_card_id uuid

Unique identifier of the gift card

delivery_type string

Specifies how the purchaser intends to deliver the gift card to the recipient.

Possible values: [send_to_some_else, send_to_myself, print_and_give]

redemption_method stringrequired

Method used to redeem the gift card

Possible values: [email, text, print]

recipient_name string

Name of the gift card recipient

recipient_email email

Email address of the recipient

recipient_phone_number string

Recipient’s phone number in the format “+1XYYYYYYYYY” or “XYYYYYYYYY”, where X > 1.

sender_name string

Name of the sender

sender_email email

Email address of the sender

custom_message string

Custom message attached to the gift card

value numberrequired

Monetary value of the gift card (in cents).

card_program string

Gift card program name. Required if no business ID is provided.

search_provider stringrequired

Provider used to search for the business. Required if the card program is not a “choose your own” type.

Possible values: [yelp, google]

business_id string

Identifier of the associated business (sourced from Yelp or Google search results). Required if the card program is not a “choose your own” type.

GiftCardRequest

{
  "gift_card_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "delivery_type": "send_to_some_else",
  "redemption_method": "email",
  "recipient_name": "string",
  "recipient_email": "user@example.com",
  "recipient_phone_number": "string",
  "sender_name": "string",
  "sender_email": "user@example.com",
  "custom_message": "string",
  "value": 0,
  "card_program": "string",
  "search_provider": "yelp",
  "business_id": "string"
}