sequence.discard

Beta

This endpoint is in beta and may not be available for all organizations.

Permanently discards a NotStarted sourcing sequence draft owned by the acting user. Drafts created with x-on-behalf-of must be discarded using the same user.

Repeating a successful discard is safe. A sequence ID that is absent from the acting organization is treated as already discarded and returns success; this response does not indicate whether the sequence previously existed. Returns sequence_not_found for a sequence that still exists in the acting organization but is inaccessible, belongs to another acting user, or is not a sourcing sequence. A sequence that has already started cannot be discarded and returns invalid_input.

Requires the sourcingWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The unique identifier for the draft sequence enrollment

Response

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