Skip to main content
PUT
/
v1
/
fields
Update a field
curl --request PUT \
  --url http://localhost:4000/v1/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 2,
  "name": "<string>",
  "identifier": "<string>",
  "description": "<string>",
  "defaultStatement": "<string>",
  "inputType": "NUMBER",
  "type": "CONTACT",
  "configuration": {
    "dateTimeFormat": "12Hour",
    "dateType": "US",
    "includedTime": true
  },
  "options": [
    {
      "name": "<string>",
      "id": 123,
      "color": "<string>",
      "isArchived": true,
      "displayIndex": 123,
      "actionId": 123,
      "category": "<string>",
      "icon": "<string>",
      "isDefault": true,
      "badge": "<string>",
      "tooltip": "<string>"
    }
  ],
  "hidden": true
}
'
{ "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
​
id
integer
required
Required range: x >= 1
​
name
string
Maximum string length: 1000
​
identifier
string
Maximum string length: 1000
​
description
string
Maximum string length: 1000
​
defaultStatement
string
Maximum string length: 1000
​
inputType
enum<string>
Available options:
NUMBER,
TEXT,
TEXT_AREA,
DATE,
USER,
USERS_MULTIPLE,
URL,
SINGLE_SELECT,
MULTIPLE_SELECT,
EMAIL,
RATING
​
type
enum<string>
Available options:
CONTACT,
CALL,
EVENT,
DEAL,
USER,
ISCORE,
UNIFIED_INBOX,
INVITEE_QUESTION
​
configuration
object

Date field configuration when time is selected.

​
options
object[]
​
hidden
boolean

Response

Custom field updated successfully

​
data
object
required
​
message
string