DELETE
/
request-types
/
{id}
Delete a request type
curl --request DELETE \
  --url https://core.ravenna.ai/api/request-types/{id} \
  --header 'x-ravenna-api-token: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "emoji": "<string>",
  "icon": "<string>",
  "isDefault": true,
  "published": true,
  "jobId": "<string>",
  "color": "<string>",
  "description": "<string>",
  "aiExamples": "<string>",
  "aiResponse": "<string>",
  "workspaceId": "<string>",
  "titleTemplate": "<string>",
  "defaultQueueId": "<string>",
  "defaultStatusId": "<string>",
  "defaultPriority": "URGENT",
  "type": "request-type",
  "parentId": "<string>",
  "parent": {
    "id": "<string>",
    "name": "<string>"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>"
    }
  ],
  "customFields": [
    {
      "id": "<string>",
      "order": 123,
      "private": true,
      "requestTypeId": "<string>",
      "customField": {
        "id": "<string>",
        "workspaceId": "<string>",
        "key": "<string>",
        "label": "<string>",
        "description": "<string>",
        "required": true,
        "system": true,
        "config": null,
        "type": "TEXT",
        "options": [
          {
            "id": "<string>",
            "value": "<string>",
            "order": 123,
            "description": "<string>",
            "color": "<string>",
            "icon": "<string>",
            "customFieldId": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "_count": {
          "requestTypeCustomField": 123
        }
      },
      "customFieldId": "<string>",
      "ticketField": "TITLE",
      "required": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "parentId": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Path Parameters

id
string
required

Query Parameters

deleteContents
boolean
default:false

Response

Successful response

id
string
required
name
string
required
emoji
string | null
required
icon
string | null
required
isDefault
boolean
required
jobId
string | null
required
color
string | null
required
description
string
required
aiExamples
string | null
required
aiResponse
string | null
required
workspaceId
string
required
titleTemplate
string | null
required
defaultQueueId
string | null
required
defaultStatusId
string | null
required
type
required
Available options:
request-type,
collection
parentId
string | null
required
parent
object | null
required
tags
object[]
required
customFields
object[]
required
createdAt
string
required
updatedAt
string
required
published
boolean
defaultPriority
enum<string>
Available options:
URGENT,
HIGH,
MEDIUM,
LOW