Delete a journey
Deletes a journey that was never published or is archived, with its versions and runs. An active or paused journey returns 409; archive it first.
DELETE
Deletes a journey that was never published or is archived, with its versions and runs. An active or paused journey returns 409; archive it first.
apiKeyheader
x-api-key<token>id*stringMatch
^jrny_[0-9a-hjkmnp-tv-z]{16,24}$DeleteJourneyResponse
application/json- response
id*JourneyIdMatch
^jrny_[0-9a-hjkmnp-tv-z]{16,24}$deleted*trueValue in
trueimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.journeys.remove({
"id": "example"
});Example Response
{
"id": "string",
"deleted": true
}