creatives-v2

Create a new creative

post/v2/creatives

Request

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

Request body

creative_typestring

Type: automated, one_time, welcome (default: automated)

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.

end_datestring nullable

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

list_control_idsinteger[]

List IDs for include/exclude control (optional)

list_control_modestring

List control mode: all (default), include, exclude (optional)

messagestring required

Message template (max 1600 chars); one_time creatives may have no link placeholders

namestring required

Creative name (max 255 chars)

start_datestring nullable

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

statusstring

Status: active or paused (default: active)

Example request

{
  "offer_links": [
    {
      "offer_source": "sms"
    }
  ]
}

Response

Creative created

successboolean

Operation success

Example response

{
  "creative": {
    "offer_links": [
      {
        "offer_source": "sms"
      }
    ]
  }
}

Changes

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