A scheduled change to make to an Offer or Goal. Can be used to change the status of an Offer or Goal, or the default payout or revenue amounts for them. Additionally can be used to change payout or revenue amounts on a per-Affiliate basis, or for an Affiliate Tier. For more information, see help.tune.com/hasoffers/offer-payouts/.
| Name | Type | Description |
|---|---|---|
| affiliate_id | Nullable Integer | This should only be provided if "model" is set to "OfferPayout" or "OfferRevenue". The ID of the Affiliate for which a payout or revenue change is being made. |
| affiliate_tier_id | Nullable Integer | This should only be provided if "model" is set to "AffiliateTierRevenue" or "AffiliateTierPayout". The ID of the Affiliate Tier for which a payout or revenue change is being made. |
| created_utc | Datetime | The date/time (UTC) this scheduled change model was created. This is not the time the change will take effect; see "update_time_utc". |
| employee_id | Nullable Integer | The ID of the Employee to which this Scheduled Offer Change should be attributed |
| goal_id | Nullable Integer | If the "model" is set to "Goal" this is required. It is optional if "model" is set to "OfferPayout", "OfferRevenue", "AffiliateTierRevenue", or "AffiliateTierPayout". It should not be provided if "model" is "Offer" as it is not applicable for Offer-model changes. |
| id | Integer | ID of unique, auto-generated object for this Scheduled Offer Change This parameter is non-writable |
| model | String | Indicates the model which will be updated by this change. "Offer" indicates that the Offer itself will be updated (status, default payout, or default revenue). "Goal" indicates that a Goal will be updated (status, default payout, or default revenue). "OfferPayout" indicates that an Affiliate-specific payout amount for an Offer or Goal will be updated. "OfferRevenue" indicates that an Affiliate-specific revenue amount for an Offer or Goal will be updated. "AffiliateTierPayout" indicates that a payout amount for an Affiliate Tier for an Offer or Goal will be updated. "AffiliateTierRevenue" indicates that a revenue amount for an Affiliate Tier for an Offer or Goal will be updated.Show Supported Values |
| modified_utc | Datetime | The date/time (UTC) this scheduled change model was last updated. This is not the time the change will take effect; see "update_time_utc". |
| offer_id | Integer | The ID of the Offer this change applies to. This is required for all scheduled changes regardless of which "model" is being changed. |
| scheduled_job_id | Nullable Integer | This is an internal identifier used to track the progression of the Scheduled Offer Change. It can be ignored. |
| status | String | The status of this change. Networks should only set the statuses "active" or "deleted". New scheduled changes should be set to "active", which indicates that the change will take effect at the scheduled date. "deleted" can be set to cancel a scheduled change. "completed" is a status set by the API, which indicates that the scheduled change has been executed. "failed" is a status set by the API, which indicates that the scheduled change was attempted but failed. Once set to "deleted" a Scheduled Offer Change cannot be updated; a new one will need to be created instead.Show Supported Values |
| type | String | This is automatically set by the API after the change request is created, to indicate the category of change.
|
| update_field | String | The property being modified by this Scheduled Offer Change. The new value to set for the property is specified in the "update_value" field.
|
| update_time_utc | Datetime | The date/time (UTC) that this Scheduled Offer Change should take effect. Format is "YYYY-MM-DD HH24:MM:SS". For example, to specify January 13, 2014 at 4:35 P.M. UTC: "2014-01-13 16:35:00". The scheduler will make its best attempt to execute the change at the specified date, but it cannot guarantee changes will happen precisely at the specified time. |
| update_value | String | The new value to set for the specified "update_field" being modified by this Scheduled Offer Change |