sequences

Stop Sequence

Changed on

Permanently stop a sequence.

Requires the sequences:write scope on the API key.

post/v1/sequences/{sequence_id}/stop

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/sequences/{sequence_id}/stop
  • Auth: HTTP bearer

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

  • 6e9ca9d5acacRevision changes
    • breaking

      removed the enum value COMPANY of the request property

    • info

      added the new ACCOUNT enum value to the request property

  • 467ce2bf692bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status