Custom Field

A custom field allows you to create a customized field to track extra characteristics and attributes of a record. Custom field object allows you to perform the following operations:

  • Retrieve a specific custom field or a list of custom fields
  • Create a custom field
  • Update a custom field
  • Delete a custom field

Learn More
  • cURL
  • NODE.JS
  • PHP
  • C#
  • PYTHON
  • JAVA
NameDescriptionFormatAttributes
labelName of the custom fieldstringMaxLength = 50
Filterable, Sortable
createdByIdIdentifier of the user who created this objectuuidFilterable
createdOnDate and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
definitionIdIdentifier of the custom field assigned to a moduleuuidFilterable
descriptionRepresents the description of the custom fieldstringMaxLength = 100
idObject identifieruuidFilterable
lastUpdatedLast updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
lastUpdatedByIdIdentifier of the user who last updated this objectuuidFilterable
lengthNumber of characters allowed in a custom fieldint32
moduleRepresents the module to which a custom field can be assigned, e.g., activity, client, employee, etc. CustomFieldModule Filterable
objectStateRepresents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
tokenRepresents the token for update operationsint32
typeRepresents the data type of custom field, e.g., text, date, etc. CustomFieldType
versionImplements concurrency on this objectbyte

Use this method to retrieve a list of custom fields. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned.

Request URL
base_url/customfield

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
fields Query Specifies the model properties you want in the response bodystring
where Query Specifies only those records that match an expression in the querystring
orderBy Query Specifies the order of the recordsstring
page Query Specifies the page number and number of records on each pagestring
expand Query string
Response Body
NameDescriptionFormat
label Name of the custom fieldstring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
definitionId Identifier of the custom field assigned to a moduleuuid
description Represents the description of the custom fieldstring
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
length Number of characters allowed in a custom fieldint32
module Represents the module to which a custom field can be assigned, e.g., activity, client, employee, etc. CustomFieldModule
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
token Represents the token for update operationsint32
type Represents the data type of custom field, e.g., text, date, etc. CustomFieldType
version Implements concurrency on this objectbyte
Example Request
Example Response
[
  {
    "label": "label",
    "createdById": "2b334173-8e29-4010-a7bd-764772344173",
    "createdOn": "2021-11-09T09:09:40Z",
    "definitionId": "6f032ef7-dcf8-4e0c-8dd1-ecd8863d99af",
    "description": "AssignedCustomField Description",
    "id": "36286fd3-822d-48ab-9abb-be669748adca",
    "lastUpdated": "2021-11-09T09:09:40Z",
    "lastUpdatedById": "8abc4c5d-40fb-49d0-985c-2b9b84e20007",
    "length": 0,
    "module": null,
    "objectState": null,
    "token": 0,
    "type": null,
    "version": "U3dhZ2dlciByb2Nrcw=="
  }
]

Use this method to retrieve a specific custom field. Pass id as the parameter.

Request URL
base_url/customfield/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Custom field identifierstring
Response Body
NameDescriptionFormat
label Name of the custom fieldstring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
description Represents the description of the custom fieldstring
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
length Number of characters allowed in a custom fieldint32
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
token Represents the token for update operationsint32
type Represents the data type of custom field, e.g., text, date, etc. CustomFieldType
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "label": "label",
  "createdById": "0958092c-d516-42cb-9443-362720265bd6",
  "createdOn": "2021-11-09T09:09:40Z",
  "description": "CustomField Description",
  "id": "a0e95488-5940-408f-a7c3-a7a40277afd3",
  "lastUpdated": "2021-11-09T09:09:40Z",
  "lastUpdatedById": "f464da49-7e69-47fd-9c35-d66c17fd89cb",
  "length": 0,
  "objectState": null,
  "token": 0,
  "type": null,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to save a custom field. Pass custom field as the parameter.

Request URL
base_url/customfield

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Custom field objectCustomField
Response Body
NameDescriptionFormat
label Name of the custom fieldstring
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
description Represents the description of the custom fieldstring
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
length Number of characters allowed in a custom fieldint32
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
token Represents the token for update operationsint32
type Represents the data type of custom field, e.g., text, date, etc. CustomFieldType
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "label": "label",
  "createdById": "6d7219df-46cd-4a7a-a604-e15c30cfd49b",
  "createdOn": "2021-11-09T09:09:40Z",
  "description": "CustomField Description",
  "id": "c4f10238-3754-4ad7-b10a-611e686463f2",
  "lastUpdated": "2021-11-09T09:09:40Z",
  "lastUpdatedById": "e706a922-088f-4cea-ba78-23bd55bc98f7",
  "length": 0,
  "objectState": null,
  "token": 0,
  "type": null,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to save multiple custom fields. Pass model as the parameter.

Request URL
base_url/customfield/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Custom field objectCustomFieldBatchRequest
Response Body
NameDescriptionFormat
batchSize Represents the number of entities in a batchint64
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted ObjectState
progress Represents the total number of entities processedint64
status Represents the status of a job e.g., ready, running, completed, or terminatedstring
token Represents the token for update operationsint32
type Represents the type of a job e.g., create, update, or deletestring
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "batchSize": 0,
  "createdById": "ad03a87f-077b-4902-a2f5-12f4672df71d",
  "createdOn": "2021-11-09T09:09:40Z",
  "id": "c8fde08f-9087-4857-846e-b5dab0ac7aae",
  "lastUpdated": "2021-11-09T09:09:40Z",
  "lastUpdatedById": "9ba00b33-19cc-414d-8290-0a6a0fcf8111",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to assign multiple custom fields to a module.

Request URL
base_url/customfield/assign

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Custom field objectAssignCustomField
Example Request

Use this method to remove a custom field from a module.

Request URL
base_url/customfield/unassign

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Custom field objectUnAssignCustomField
Example Request

Use this method to retrieve a specific custom field. Pass id as the parameter.

Request URL
base_url/customfield/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Custom field identifierstring
body Body Custom field objectCustomField
Response Body
NameDescriptionFormat
Example Request
Example Response
{
  "label": "label",
  "createdById": "2ddf7133-0154-4cae-be5d-9fbf669aa72c",
  "createdOn": "2021-11-09T09:09:40Z",
  "description": "CustomField Description",
  "id": "076e7161-99d7-4f39-ab63-34310bcda842",
  "lastUpdated": "2021-11-09T09:09:40Z",
  "lastUpdatedById": "4a74d62b-c722-47fa-a2b2-405c0af41aab",
  "length": 0,
  "objectState": null,
  "token": 0,
  "type": null,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to delete a custom field. Pass id as the parameter. You can only delete a custom field if it is not assigned to any module.

Request URL
base_url/customfield/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Custom field identifierstring
Example Request

Use this method to perform partial modifications to a custom field. Pass id and patch document as parameters.

Request URL
base_url/customfield/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

CustomField

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Custom field identifierstring
body Body A document containing an array of objects with each object representing a single operationCustomFieldPatchDocument
Response Body
NameDescriptionFormat
Example Request
Example Response