ScheduledOfferChange Model

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/.

NameTypeDescription
affiliate_idNullable IntegerThis 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_idNullable IntegerThis 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_utcDatetimeThe date/time (UTC) this scheduled change model was created. This is not the time the change will take effect; see "update_time_utc".
employee_idNullable IntegerThe ID of the Employee to which this Scheduled Offer Change should be attributed
goal_idNullable IntegerIf 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.
idIntegerID of unique, auto-generated object for this Scheduled Offer Change
This parameter is non-writable
modelString 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_utcDatetimeThe 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_idIntegerThe ID of the Offer this change applies to. This is required for all scheduled changes regardless of which "model" is being changed.
scheduled_job_idNullable IntegerThis is an internal identifier used to track the progression of the Scheduled Offer Change. It can be ignored.
statusString 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
typeString This is automatically set by the API after the change request is created, to indicate the category of change.
  • "status" indicates a change in status of an Offer or Goal.
  • "payout" indicates a change in the default Offer ("model"="Offer") or Goal ("model"="Goal") payout, or a change to an Affiliate Tier Payout ("model"="AffiliateTierPayout") or Affiliate-specific payout ("model"="OfferPayout").
  • "revenue" indicates a change in the default Offer ("model"="Offer") or Goal ("model"="Goal") revenue, or a change to an Affiliate Tier Revenue ("model"="AffiliateTierRevenue") or Affiliate-specific revenue ("model"="OfferRevenue").
Show Supported Values
update_fieldString The property being modified by this Scheduled Offer Change. The new value to set for the property is specified in the "update_value" field.
  • "status" is valid only if "model" is set to "Offer" or "Goal", and specifies that the status of the Offer or Goal be changed to the value specified in "update_value".
  • "default_payout" is valid only if "model" is set to "Offer" or "Goal", and indicates that the default flat payout will be updated to the value specified in "update_value".
  • "max_payout" is valid only if "model" is set to "Offer" or "Goal", and indicates that the default flat revenue amount will be updated to the value specified in "update_value".
  • "percent_payout" is valid only if "model" is set to "Offer" or "Goal", and indicates that the default percent payout will be updated to the value specified in "update_value".
  • "max_percent_payout" is valid only if "model" is set to "Offer" or "Goal", and indicates that the default percent revenue rate will be updated to the value specified in "update_value".
  • "rate" is valid only if "model" is set to "OfferPayout", "OfferRevenue", "AffiliateTierPayout", or "AffiliateTierRevenue", and indicates that the flat rate amount specified for the payout or revenue model will be updated to the value specified in the "update_value" field.
  • "percent" is valid only if "model" is set to "OfferPayout", "OfferRevenue", "AffiliateTierPayout", or "AffiliateTierRevenue", and indicates that the percent amount specified for the payout or revenue model will be updated to the value specified in the "update_value" field.
Note: changes to flat rate or percent payout fields on any model type will only take effect if the Offer or Goal has a "payout_type" or "revenue_type" that uses flat amounts or percentages in its payout or revenue calculations. Similarly, changes to tiered revenue or payouts will only take effect if the Offer or Goal has "tiered_payout" or "tiered_revenue" enabled. See the Offer and Goal models for more information.Show Supported Values
update_time_utcDatetimeThe 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_valueString The new value to set for the specified "update_field" being modified by this Scheduled Offer Change
Have a Question? Please contact support@tune.com for technical support.