schedules-v2

Update a schedule

Cannot edit completed schedules.

put/v2/schedules/{schedule_id}

Request

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

Request body

audiencesstring[]

Audience IDs

automated_percentnumber

Automated selection percentage

end_datestring date-time

Repeating end date

filter_botsboolean

Filter bots

ir_revenuenumber

Expected revenue

is_ctoboolean

Click-to-open mode

is_mmsboolean

MMS mode

is_repeatingboolean

Whether schedule repeats

namestring

Schedule name

send_datestring date-time

One-time send date

send_timestring

Send time (HH:MM)

send_typestring

Type: blast or automated

skip_within_hoursnumber

Skip if sent within hours

source_listsinteger[]

Source list IDs

start_datestring date-time

Repeating start date

statusstring

Status: draft, off, on, complete, archive

use_local_timeboolean

Use recipient local time

Response

Schedule updated

audiencesstring[]

Audience IDs

automated_percentnumber

Automated selection percentage

created_atstring date-time

Creation timestamp

end_datestring date-time

Repeating end date

filter_botsboolean

Filter bots

idstring

Schedule ID

ir_revenuenumber

Expected revenue

is_ctoboolean

Click-to-open mode

is_mmsboolean

MMS mode

is_repeatingboolean

Whether schedule repeats

is_transactionalboolean

Read-only. True when this schedule is marked transactional and its messages skip TCPA sending restrictions. Settable only in the Trackly UI, which requires an explicit owner acknowledgement.

namestring

Schedule name

send_datestring date-time

One-time send date

send_timestring

Send time (HH:MM)

send_typestring

Type: blast or automated

skip_within_hoursnumber

Skip if sent within hours

source_listsinteger[]

Source list IDs

start_datestring date-time

Repeating start date

statusstring

Status: draft, off, on, complete, archive

updated_atstring date-time

Last update timestamp

use_local_timeboolean

Use recipient local time

Changes

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