The gift card recipient object
A comprehensive list of the gift card recipient resource's attributes and relationships
A gift card recipient object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/gift_card_recipients
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The gift card recipient unique identifier |
links.self |
| The gift card recipient endpoint URL |
attributes.created_at |
| Time at which the resource was created. |
attributes.email |
| The recipient email address. |
attributes.first_name |
| The recipient first name. |
attributes.last_name |
| The recipient last name. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.attachments |
| The associated attachments. |
relationships.customer |
| The associated customer. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated