KIkit
Sequences

Update a sequence

Updates any sequence settings — name, email_address, schedule (send_days, send_hour, time_zone), email_template_id, exclude_subscriber_sources, or the active / repeat / hold flags. Only fields included in the request body change; everything else is preserved.

Some changes have user-visible side effects on subscribers already in the sequence:

Note: flipping active from false to true resumes delivery for queued subscribers. Flipping it back to false pauses the sequence — subscribers stay in their current position but no new emails are sent until it's reactivated.

Note: changing the schedule (send_days, send_hour, or time_zone) only affects future sends. It does not retroactively reschedule emails already queued for delivery.

Warning: turning off repeat while subscribers are mid-sequence does not stop them from finishing — but they won't be re-eligible to start over after completing.

See Create a sequence for the full sequence model and what each field controls.

put/v4/sequences/{id}

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/sequences/{id}
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Path parameters

idinteger required

Request body

namestring

The name of the sequence.

email_addressstring

The sending email address to use. Uses the account's sending email address if not provided.

email_template_idinteger

Id of the email template to use.

send_daysstring[]

The days of the week to send the sequence on. Must be one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

send_hourinteger

The hour of the day to send the sequence at. Must be an integer between 0 and 23.

time_zonestring

The timezone to use for the sequence. Must be a valid IANA timezone string.

activeboolean

true to activate the sequence, false to deactivate it.

repeatboolean

When true, subscribers can restart the sequence multiple times.

holdboolean

When true, subscribers added via Visual Automations stay in the sequence after receiving the last email.

Response

Updates the sequence and returns its details

Changes

No recorded changes to this operation across all 2 revisions of this API.