Delete interview flow - Ribbon API Documentation

DELETE

interview-flows

{interview_flow_id}

Delete interview flow

curl --request DELETE \
  --url https://app.ribbon.ai/be-api/v1/interview-flows/{interview_flow_id} \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "interview_flow_id": "<string>",
  "status": "<string>"
}

Authorizations

Authorization

string

header

required

Provide your API key UUID in the 'Authorization' header prefixed with 'Bearer '. Example: 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000'

Path Parameters

interview_flow_id

string

required

Minimum string length: 1

Response

success

boolean

required

Indicates successful deletion of the interview flow.

interview_flow_id

string

required

The ID of the interview flow that was archived.

status

string

required

The new status of the interview flow after deletion.

Get interviewsRetrieve all interview sessions. If team_id is not provided, returns interviews for all teams in the organization.

Delete interview flow

curl --request DELETE \
  --url https://app.ribbon.ai/be-api/v1/interview-flows/{interview_flow_id} \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "interview_flow_id": "<string>",
  "status": "<string>"
}