ScheduledOfferChange::findScheduleById

Jump to: GET Response Notes | API Call Builder

Find a Scheduled Offer Change by its ID.

= Required Parameter

Name

Type

Description

Integer

ID of the Scheduled Offer Change

fields

Array

List of fields to return; defaults to all fieldsShow Supported Values

Any of the following values from the ScheduledOfferChange model are supported.

Name	Description
affiliate_id	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	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	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	The ID of the Employee to which this Scheduled Offer Change should be attributed
goal_id	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	ID of unique, auto-generated object for this Scheduled Offer Change
model	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.
modified_utc	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	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	This is an internal identifier used to track the progression of the Scheduled Offer Change. It can be ignored.
status	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.
type	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").
update_field	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.
update_time_utc	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	The new value to set for the specified "update_field" being modified by this Scheduled Offer Change

Show Supported Values

GET Response Notes

An array containing the scheduled offer change.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.