Name | Type | Description | Notes |
---|---|---|---|
id | int | Internal ID of this entity. | |
created | \DateTime | The time this entity was created. | |
startDate | \DateTime | Timestamp at which point the referral code becomes valid. | [optional] |
expiryDate | \DateTime | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] |
usageLimit | int | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | |
campaignId | int | ID of the campaign from which the referral received the referral code. | |
advocateProfileIntegrationId | string | The Integration ID of the Advocate's Profile. | |
friendProfileIntegrationId | string | An optional Integration ID of the Friend's Profile. | [optional] |
attributes | object | Arbitrary properties associated with this item. | [optional] |
importId | int | The ID of the Import which created this referral. | [optional] |
code | string | The referral code. | |
usageCounter | int | The number of times this referral code has been successfully used. | |
batchId | string | The ID of the batch the referrals belong to. | [optional] |
referredCustomers | string[] | An array of referred customers. |