Delete Journey State

(v2)

DELETE

Permanently deletes a state and its edges, along with every state that could only be reached through it, and returns the ids of all the states removed. Goldens generated for a path through any of them are kept but no longer belong to any path. The root state cannot be deleted; trying returns a 400.

DELETE/v2/journeys/{journeyId}/states/{stateId}

curl -X DELETE "https://api.confident-ai.com/v2/journeys/{journeyId}/states/{stateId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "id": "<JOURNEY-STATE-ID>",
    "deletedStateIds": [
      "<JOURNEY-STATE-ID>"
    ]
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/journeys/<JOURNEY-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

journeyIdstringRequired
The id of the journey the state belongs to.
stateIdstringRequired
The id of the state.

Response

Delete Journey State succeeded.

successboolean
Indicates if the request was successful.
dataobject
The states removed by deleting a state from a journey.
Show 2 propertiesHide 2 properties
- idstring
  The id of the state you deleted.
- deletedStateIdslist of strings
  Every state removed: the one you deleted, then any state that could only be reached through it.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI