Recipient Object


The Recipient entity contains the information about the recipient of a gift card, such as name, email, gifting details, and the created gift card.

Properties
idstringRead-onlyformat GUID

Recipient ID.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the Recipient is updated. To prevent conflicting changes, the current revision must be passed when updating the Recipient.

Ignored when creating a Recipient.


createdDatestringRead-onlyformat date-time

Date and time the Recipient was created.


updatedDatestringRead-onlyformat date-time

Date and time the Recipient was last updated.


namestringmaxLength 200immutable

The name of the recipient.


emailstringformat EMAILimmutable

The email of the recipient.


giftCardIdstringformat GUIDimmutable

The ID of the gift card that was sent to the recipient.


giftingDetailsGiftingDetails

Optional gifting details to add to the email.

Did this help?