| Name | Type | Description | Notes |
|---|---|---|---|
| start_date | datetime | Timestamp at which point the referral code becomes valid. | [optional] |
| expiry_date | datetime | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] |
| usage_limit | int | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | |
| campaign_id | int | The ID of the campaign from which the referral received the referral code. | |
| advocate_profile_integration_ids | list[str] | An array containing all the respective advocate profiles. | |
| attributes | object | Arbitrary properties associated with this referral code. | [optional] |
| valid_characters | list[str] | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] |
| referral_pattern | str | The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional] |