Skip to main content
POST
/
request-type-custom-fields
Create a new request type custom field
curl --request POST \
  --url https://core.ravenna.ai/api/request-type-custom-fields \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "id": "<string>",
  "order": 123,
  "private": true,
  "required": true,
  "system": true,
  "requestTypeId": "<string>",
  "customFieldId": "<string>",
  "customField": {
    "id": "<string>",
    "key": "<string>",
    "label": "<string>",
    "description": "<string>",
    "required": true,
    "config": {
      "fileTypes": [
        {
          "id": "<string>"
        }
      ],
      "allowList": [
        {
          "id": "<string>"
        }
      ]
    },
    "type": "TEXT",
    "options": [
      {
        "value": "<string>",
        "order": 123
      }
    ]
  },
  "parentId": "<string>"
}'
{
  "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>"
}

Authorizations

​
x-ravenna-api-token
string
header
required

Body

application/json
​
requestTypeId
string
required
​
id
string
​
order
number
​
private
boolean
​
required
boolean
​
system
boolean
​
customFieldId
string | null
​
customField
object | null
​
parentId
string | null

Response

Successful response

​
id
string
required
​
order
number
required
​
private
boolean
required
​
requestTypeId
string
required
​
customField
object
required
​
customFieldId
string
required
​
ticketField
enum<string> | null
required
Available options:
TITLE,
DESCRIPTION,
STATUS,
PRIORITY,
REQUESTER,
ASSIGNEE,
APPROVERS,
FOLLOWERS
​
required
boolean
required
​
createdAt
string
required
​
updatedAt
string
required
​
parentId
string | null
required
⌘I