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
- cURL
- NODE.JS
- PHP
- C#
- PYTHON
- JAVA
The Custom Field Object
asterisk denotes required| Name | Description | Format | Attributes |
|---|---|---|---|
| label | Name of the custom field | string | MaxLength = 50 Filterable, Sortable |
| createdById | Identifier of the user who created this object | uuid | Filterable |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| definitionId | Identifier of the custom field assigned to a module | uuid | Filterable |
| description | Represents the description of the custom field | string | MaxLength = 100 |
| id | Object identifier | uuid | Filterable |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| lastUpdatedById | Identifier of the user who last updated this object | uuid | Filterable |
| length | Number of characters allowed in a custom field | int32 | |
| module | Represents the module to which a custom field can be assigned, e.g., activity, client, employee, etc. | CustomFieldModule | Filterable |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState | |
| token | Represents the token for update operations | int32 | |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldType | |
| version | Implements concurrency on this object | byte |
CustomField List
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
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| fields | Query | Specifies the model properties you want in the response body | string |
| where | Query | Specifies only those records that match an expression in the query | string |
| orderBy | Query | Specifies the order of the records | string |
| page | Query | Specifies the page number and number of records on each page | string |
| expand | Query | string |
Response Body
| Name | Description | Format |
|---|---|---|
| label | Name of the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| definitionId | Identifier of the custom field assigned to a module | uuid |
| description | Represents the description of the custom field | string |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| length | Number of characters allowed in a custom field | int32 |
| 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 operations | int32 |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldType |
| version | Implements concurrency on this object | byte |
[
{
"label": "label",
"createdById": "8ffcc0b0-0b9e-4120-a289-5925f78a276f",
"createdOn": "2022-01-04T11:24:49Z",
"definitionId": "8891b9a9-632b-469c-a25d-e4f80d24a570",
"description": "AssignedCustomField Description",
"id": "d709a2ca-36a3-4960-b6ca-a0a6879ea06c",
"lastUpdated": "2022-01-04T11:24:49Z",
"lastUpdatedById": "f561c656-a4fc-44d1-adb0-949c214f2b4d",
"length": 0,
"module": null,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]Retrieve a CustomField
Use this method to retrieve a specific custom field. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
Response Body
| Name | Description | Format |
|---|---|---|
| label | Name of the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| description | Represents the description of the custom field | string |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| length | Number of characters allowed in a custom field | int32 |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState |
| token | Represents the token for update operations | int32 |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldType |
| version | Implements concurrency on this object | byte |
{
"label": "label",
"createdById": "5c9c8de3-74cf-4bcf-b4f2-7a19221949e1",
"createdOn": "2022-01-04T11:24:50Z",
"description": "CustomField Description",
"id": "8aa88e39-0192-450e-85eb-d9b73cf2509c",
"lastUpdated": "2022-01-04T11:24:50Z",
"lastUpdatedById": "7ac10426-343c-4402-9387-44aaf8cc09d7",
"length": 0,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Create a CustomField
Use this method to save a custom field. Pass custom field as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | CustomField |
Response Body
| Name | Description | Format |
|---|---|---|
| label | Name of the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| description | Represents the description of the custom field | string |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| length | Number of characters allowed in a custom field | int32 |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState |
| token | Represents the token for update operations | int32 |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldType |
| version | Implements concurrency on this object | byte |
{
"label": "label",
"createdById": "a79e4d8f-45a9-4820-92b5-5f5e033b4f4a",
"createdOn": "2022-01-04T11:24:50Z",
"description": "CustomField Description",
"id": "da953a71-e108-424c-bb1a-e95a81a4a284",
"lastUpdated": "2022-01-04T11:24:50Z",
"lastUpdatedById": "ddeab602-11d1-4e80-89fb-9e7238dd815b",
"length": 0,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Create a CustomField List
Use this method to save multiple custom fields. Pass model as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | CustomFieldBatchRequest |
Response Body
| Name | Description | Format |
|---|---|---|
| batchSize | Represents the number of entities in a batch | int64 |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState |
| progress | Represents the total number of entities processed | int64 |
| status | Represents the status of a job e.g., ready, running, completed, or terminated | string |
| token | Represents the token for update operations | int32 |
| type | Represents the type of a job e.g., create, update, or delete | string |
| version | Implements concurrency on this object | byte |
{
"batchSize": 0,
"createdById": "af37847f-2c91-47ad-940a-c6b9122dd0fd",
"createdOn": "2022-01-04T11:24:50Z",
"id": "ce875a5c-a211-496c-b749-44ff2e4bb4cd",
"lastUpdated": "2022-01-04T11:24:50Z",
"lastUpdatedById": "e8cf582e-e6ad-4091-8f17-c56ca001c96b",
"objectState": null,
"progress": 0,
"status": "status",
"token": 0,
"type": "type",
"version": "U3dhZ2dlciByb2Nrcw=="
}Create a CustomField Assign
Use this method to assign multiple custom fields to a module.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | AssignCustomField |
Create a CustomField Unassign
Use this method to remove a custom field from a module.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | UnAssignCustomField |
Update a CustomField
Use this method to retrieve a specific custom field. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
| body | Body | Custom field object | CustomField |
Response Body
| Name | Description | Format |
|---|
{
"label": "label",
"createdById": "591b9946-30f8-499d-b4d8-f9e34d5940b9",
"createdOn": "2022-01-04T11:24:50Z",
"description": "CustomField Description",
"id": "368f39e4-bd36-4aa6-a4dc-84b3601d3a41",
"lastUpdated": "2022-01-04T11:24:50Z",
"lastUpdatedById": "bba424a0-7a27-4520-8d6d-bdc17e566cee",
"length": 0,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Delete a CustomField
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
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
Patch a CustomField
Use this method to perform partial modifications to a custom field. Pass id and patch document as parameters.
Request URL
Method Overview
HTTP Method:
PATCH
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
CustomField
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
| body | Body | A document containing an array of objects with each object representing a single operation | CustomFieldPatchDocument |
Response Body
| Name | Description | Format |
|---|