offers-v2

Create a new offer

post/v2/offers

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/offers
  • Auth: API key in header X-Api-Key

Request body

advertiserstring

Advertiser entity ID owned by this account, as returned in the advertiser field of GET /v2/offers

advertiser_idstring

Advertiser ID

dates_timezonestring nullable

Timezone for start_date/end_date: America/New_York, America/Chicago, America/Denver, America/Los_Angeles or UTC. Null = the account timezone.

day_partingobject

Allow-list of send windows by lowercase weekday, evaluated in Eastern Time. Shape {"monday": [{"start": "HH:MM", "end": "HH:MM"}]}; 24h zero-padded times, start < end (no overnight crossing), max 6 ranges/day; omit a weekday to block it.

day_parting_enabledboolean

Whether intra-day send-window restrictions apply

end_datestring nullable

Last day the offer may be sent, inclusive (YYYY-MM-DD, in dates_timezone). Null = no end.

excluded_days_of_weekstring[]

Weekdays the SMS ad server will not send this offer (contact-local)

external_idstring

External platform ID

external_platformstring

External platform: tune, everflow, or null

filter_botsboolean

Whether to filter bots (default: false)

metadataobject

Custom metadata fields

namestring required

Offer name (max 255 chars)

payoutnumber

Payout amount (default: 0)

payout_typestring

Payout type: cpa or cpc (default: cpa)

platform_config_idstring

ID of the integration to link this offer to

start_datestring nullable

First day the offer may be sent (YYYY-MM-DD, in dates_timezone). Null = no start limit.

statusstring

Status: active or paused (default: active)

tracking_urlstring required

Tracking URL

Response

Offer created

successboolean

Operation success

Changes

No recorded changes to this operation across all 1 revision of this API.