Sign in
sequences

Stop Sequence

Permanently stop a sequence.

Requires the sequences:write scope on the API key.

post/v1/sequences/{sequence_id}/stop

Path parameters

sequence_idstring uuid required

ID of the sequence.

Request body

reason'WIN' | 'LOSE' required
scope'CONTACT' | 'ACCOUNT' required

Response

Successful Response

idstring uuid required

Unique identifier.

organization_idstring uuid required

Workspace this sequence belongs to.

contact_idstring uuid nullable required

Contact this sequence is targeting.

sequence_template_idstring uuid required

Template the sequence was instantiated from.

status'ACTIVE' | 'SUCCEEDED' | 'FAILED' | 'COMPLETED' | 'WAITING_FOR_LEAD' | 'WAITING_FOR_USER' | 'STOPPED_EARLY' | 'FOUND' | 'REFUSED' required
variablesobject nullable required

Per-run template variables substituted into outbound messages.

source_contact_list_idstring uuid nullable required

Contact list that triggered this sequence, if any.

last_step_executed_atstring date-time nullable required

When the most recent step ran.

created_atstring date-time required

When the sequence was created.

updated_atstring date-time required

When the sequence last changed.

Changes

Changed in 2 of the 12 revisions of this API.13

  • 6e9ca9d5acac11See the full diff
    • ▲

      removed the enum value COMPANY of the request property scope

      request-property-enum-value-removed

    • ○

      added the new ACCOUNT enum value to the request property scope

      request-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 467ce2bf692b2See the full diff
    • ○

      added the optional property contact to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sequence_template to the response with the 200 status

      response-optional-property-added