OfferUrl::create | TUNE Dev Hub

Jump to: POST Response Notes | API Call Builder

Creates an offer URL with the provided data properties.

= Required Parameter

Name

Type

Description

data

Object

Offer Url model object data propertiesShow Supported Parameters

The following parameters are supported by this object.

Name	Type	Description
created	Datetime	The date this Offer URL was created
is_private	Nullable Boolean	Whether this Offer URL should be visible to Affiliates
modified	Datetime	The last time this Offer URL was updated
name	String	The name of the Offer URL
offer_id	Integer	The ID of the Offer this URL is for
offer_url	String	The URL to redirect all tracking links for the Offer URL. There are several optional variables that can be included in the "offer_url" which will be replaced before redirection. Affiliate ID - Include {affiliate_id} and it will be replaced by the ID of the Affiliate promoting the offer. Affiliate Sub ID - Include {aff_sub} and it will be replaced by the value of Affiliate Sub ID passed in via an affiliate tracking link. Affiliate Source - Include {source} and it will be replaced by the value of Affiliate Source passed in via an affiliate tracking link. Offer ID - Include {offer_id} and it will be replaced by the ID of the Offer. Offer URL ID - Include {offer_url_id} and it will be replaced by the ID of the Offer URL used. Advertiser ID - Include {advertiser_id} and it will be replaced by the ID of the Advertiser of the offer. Country Code - Include {country_code} and it will be replaced by the user's country code (ISO 2-letter code, i.e. US). Custom Variables - Include {params} if the Custom Variables option above is enabled. {params} will be replaced by the extra variables passed by the Affiliate into the affiliate tracking link. Transaction ID - Include {transaction_id} to send a unique transaction number to the Advertiser. Use this when trying to verify individual leads or when server response tracking is required. Offer Reference ID - Include {offer_ref} and it will be replaced by the Reference ID of the offer. Affiliate Reference ID - Include {affiliate_ref} and it will be replaced by the Reference ID of the Affiliate promoting the offer. Advertiser Reference ID - Include {advertiser_ref} and it will be replaced by the Reference ID of the Advertiser of the offer.
preview_url	String	A URL that often skips any geo-targeting or other re-targeting implemented on the "offer_url". Allows users to view a sample landing page.
status	String	The status of this Offer URL

Show Supported Parameters

return_object

Boolean

If true, returns affected object; defaults to true

POST Response Notes

Returns the ID of the newly created offer URL as an integer or returns the newly created OfferUrl model object if return_object is "true"

API Call Builder

Javascript is required to use the API Call Builder.