creatives-v2

Update a creative

put/v2/creatives/{creative_id}

Request

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

Request body

creative_typestring

Type: automated, one_time, welcome

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

list_control_modestring

List control mode: all, include, exclude

messagestring

Message template (max 1600 chars), validated against stored mappings and type unless replaced. One_time creatives may have no link placeholders.

namestring

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, paused, or archived

Example request

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

Response

Creative updated

character_countinteger

Estimated character count

created_atstring date-time

Creation timestamp

creative_typestring

Type: automated, one_time, welcome

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.

idinteger

Creative ID

list_control_idsinteger[]

List IDs for include/exclude control

list_control_modestring

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

messagestring

Message template with {{linkN}} placeholders

namestring

Creative name

offersstring[]

List of offer IDs used

segment_countinteger

Estimated SMS segment count

start_datestring nullable

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

statusstring

Status: active, paused, archived

Example response

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

Changes

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