Skip to main content
PUT
/
request-types
/
{id}
Update a request type
curl --request PUT \
  --url https://core.ravenna.ai/api/request-types/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "name": "<string>",
  "color": "<string>",
  "emoji": "<string>",
  "icon": "<string>",
  "isDefault": true,
  "isPrivate": true,
  "published": true,
  "titleTemplate": "<string>",
  "aiExamples": "<string>",
  "aiResponse": "<string>",
  "defaultQueueId": "<string>",
  "defaultStatusId": "<string>",
  "defaultTaskTemplateId": "<string>",
  "defaultPriority": "URGENT",
  "description": "<string>",
  "type": "request-type",
  "parentId": "<string>",
  "tags": [
    {
      "id": "<string>"
    }
  ],
  "agents": [
    {
      "id": "<string>"
    }
  ],
  "formEnabled": true
}'
{
  "id": "<string>",
  "name": "<string>",
  "emoji": "<string>",
  "icon": "<string>",
  "isDefault": true,
  "isPrivate": true,
  "published": true,
  "jobId": "<string>",
  "color": "<string>",
  "description": "<string>",
  "aiExamples": "<string>",
  "aiResponse": "<string>",
  "workspaceId": "<string>",
  "titleTemplate": "<string>",
  "defaultQueueId": "<string>",
  "defaultStatusId": "<string>",
  "defaultTaskTemplateId": "<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": "<any>",
        "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>"
    }
  ],
  "formEnabled": true,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
x-ravenna-api-token
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
name
string
Minimum length: 1
​
color
string | null
​
emoji
string | null
​
icon
string | null
​
isDefault
boolean
​
isPrivate
boolean
​
published
boolean
​
titleTemplate
string | null
​
aiExamples
string | null
​
aiResponse
string | null
​
defaultQueueId
string | null
​
defaultStatusId
string | null
​
defaultTaskTemplateId
string | null
​
defaultPriority
enum<string>
Available options:
URGENT,
HIGH,
MEDIUM,
LOW
​
description
string
Minimum length: 1
​
type
Available options:
request-type,
collection
​
parentId
string | null
​
tags
object[]
​
agents
object[]
​
formEnabled
boolean

Response

Successful response

​
id
string
required
​
name
string
required
​
emoji
string | null
required
​
icon
string | null
required
​
isDefault
boolean
required
​
isPrivate
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
​
defaultTaskTemplateId
string | null
required
​
type
required
Available options:
request-type,
collection
​
parentId
string | null
required
​
parent
object | null
required
​
tags
object[]
required
​
customFields
object[]
required
​
formEnabled
boolean
required
​
createdAt
string
required
​
updatedAt
string
required
​
published
boolean
​
defaultPriority
enum<string>
Available options:
URGENT,
HIGH,
MEDIUM,
LOW
⌘I