Response body for POST /customers
.
Name | Type | Description |
---|---|---|
id | String | The ID of an existing customer that will be linked to redemption in this request. |
sourceId | String | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. |
summary | CustomerSummary | |
loyalty | CustomerLoyalty | |
referrals | CustomerReferrals | |
systemMetadata | Object | Object used to store system metadata information. |
createdAt | OffsetDateTime | Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format. |
updatedAt | OffsetDateTime | Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format. |
assets | CustomerResponseDataAssets | |
_object | ObjectEnum | The type of the object represented by JSON. |
name | String | Customer's first and last name. |
description | String | An arbitrary string that you can attach to a customer object. |
String | Customer's email address. | |
phone | String | Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. |
birthday | LocalDate | `Deprecated`. |
birthdate | LocalDate | Customer's birthdate; format YYYY-MM-DD. |
address | CustomerBaseAddress | |
metadata | Object | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. |
Name | Value |
---|---|
CUSTOMER | "customer" |