Skip to main content
POST
/
v1
/
fields
Create a field
curl --request POST \
  --url http://localhost:4000/v1/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "inputType": "NUMBER",
  "type": "CONTACT",
  "identifier": "<string>",
  "description": "<string>",
  "defaultStatement": "<string>",
  "configuration": {
    "dateTimeFormat": "12Hour",
    "dateType": "US",
    "includedTime": true
  },
  "options": "<string>"
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "inputType": "<string>",
    "type": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "identifier": "<string>",
    "description": "<string>",
    "options": "<string>",
    "optionsAttributes": "<string>",
    "defaultStatement": "<string>",
    "configuration": {
      "dateTimeFormat": "12Hour",
      "dateType": "US",
      "includedTime": true
    },
    "isSystemField": true,
    "hidden": true,
    "accountId": 123,
    "userId": 123,
    "deletedAt": "2023-11-07T05:31:56Z",
    "associationCount": 123,
    "CustomFieldOptions": [
      {
        "name": "<string>",
        "id": 123,
        "color": "<string>",
        "isArchived": true,
        "displayIndex": 123,
        "actionId": 123,
        "category": "<string>",
        "icon": "<string>",
        "isDefault": true,
        "badge": "<string>",
        "tooltip": "<string>"
      }
    ],
    "CustomFieldEventMap": [
      {
        "event": {
          "name": "<string>",
          "color": "<string>",
          "linkPrefix": "<string>",
          "internalDescription": "<string>"
        }
      }
    ],
    "user": {
      "firstName": "<string>",
      "lastName": "<string>"
    }
  },
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key required in Authorization header. Format: iclosed-<token>

Body

application/json
​
name
string
required
Required string length: 1 - 1000
​
inputType
enum<string>
required
Available options:
NUMBER,
TEXT,
TEXT_AREA,
DATE,
USER,
USERS_MULTIPLE,
URL,
SINGLE_SELECT,
MULTIPLE_SELECT,
EMAIL,
RATING
​
type
enum<string>
required
Available options:
CONTACT,
CALL,
EVENT,
DEAL,
USER,
ISCORE,
UNIFIED_INBOX,
INVITEE_QUESTION
​
identifier
string
Maximum string length: 1000
​
description
string
Maximum string length: 1000
​
defaultStatement
string
Maximum string length: 1000
​
configuration
object

Date field configuration when time is selected.

​
options

Response

Custom field created successfully

​
data
object
required
​
message
string