Sha256: b9e3e01ffbd4414fdbe9dfc09cd22458325e05390525ecc852dc02cee00b978c

Contents?: true

Size: 1.47 KB

Versions: 4

Compression:

Stored size: 1.47 KB

Contents

# TalonOne::NewReferral

## Properties

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, zero, or negative. | [optional] 
**usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.  | [optional] 
**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
**advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. | 
**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile. | [optional] 
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] 

## Code Sample

```ruby
require 'TalonOne'

instance = TalonOne::NewReferral.new(start_date: 2020-11-10T23:00Z,
                                 expiry_date: 2021-11-10T23:00Z,
                                 usage_limit: 1,
                                 campaign_id: 78,
                                 advocate_profile_integration_id: URNGV8294NV,
                                 friend_profile_integration_id: BZGGC2454PA,
                                 attributes: {"channel":"web"})
```


Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
talon_one-5.0.0 docs/NewReferral.md
talon_one-3.0.2 docs/NewReferral.md
talon_one-3.0.1 docs/NewReferral.md
talon_one-3.0.0 docs/NewReferral.md