SparrowDesk
ConversationsFields

Create a conversation field

POST
/conversations/fields

Authorization

AuthorizationBearer <token>

In: header

Request Body

namestring
internal_name?string
typestring
Value in"single_line_text" | "multi_line_text" | "dropdown" | "number" | "date" | "email"
description?string
is_mandatory_on_close?boolean
Defaultfalse
field_options?array<string>

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://app.sparrowdesk.com/v1/conversations/fields" \  -H "Content-Type: application/json" \  -d '{    "name": "Product Version",    "type": "single_line_text"  }'
{
  "data": {
    "id": 103,
    "name": "Product Version",
    "internal_name": "product_version",
    "type": "single_line_text",
    "description": "Version of the product the issue relates to",
    "is_active": true,
    "is_default": false,
    "is_mandatory_on_close": false,
    "field_options": [
      {
        "id": 1,
        "name": "v1.0",
        "position": 1
      }
    ],
    "created_at": 1672531200,
    "updated_at": 1672531200
  }
}
{
  "error": {
    "message": "Field with internal name 'priority_level' already exists"
  }
}
{
  "error": {
    "message": "field_options are required for dropdown type fields"
  }
}
{
  "error": {
    "message": "Error creating conversation field"
  }
}