/sequences/{sequenceId}/deactivate

Deactivate a sequence: automatic dispatch skips it, and it can no longer be started on a tour. It keeps its rank, so activating it puts it back in its place in the dispatch order. Nothing else is checked, so a sequence the rules of POST /sequences refuse now (a carrier or brick deleted since) can always be switched off. Deactivating an inactive sequence changes nothing and keeps its version; otherwise version advances. The response is the stored sequence, with its summary.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the sequence

Responses

401

unauthorized

403

The role of the API key does not allow this action. The key needs a role with the matching permission, for example full access.

404

sequence not found: no sequence with this ID in the tenant of the key

409

conflict - other requests kept changing the sequence (internalCode CONCURRENT_UPDATE). Nothing is written; send the request again.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json