Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Custom Fields

Update an existing Custom Field

Updates an existing Custom Field and returns the updated object.

put/v2/customfields/{id}

Path parameters

idstring required
Example:CF-eYLPK7198xVp6Z8q

The custom field ID (prefix CF-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

namestring

The custom field name.

groupIdstring

The ID of the custom fields group (prefix CFG-). Use -1 for no group. Defaults to -1.

jobTypesstring[]

Array of job type IDs to associate with the custom field (prefix JT-).

optionsstring[]

The options of the custom field (Drop Down type only).

positionnumber

The position of the custom field.

requiredboolean

Indicates whether the custom field is required or not. (job only)

requiredCloseboolean

Indicates whether the custom field is required to close the job. (job only)

searchableboolean

Indicates whether the custom field is searchable or not.

Example request

{
  "name": "Custom Field 1",
  "groupId": "CFG-KMYQvPr0GZWwke3z",
  "jobTypes": [
    "JT-KMYQvPr0GZWwke3z",
    "JT-AMYQvPr0GZWwke4a"
  ],
  "options": [
    "option 1",
    "option 2",
    "option 3"
  ],
  "position": 1
}

Response

The updated Custom Field.

idstring

The ID of the custom field (prefix CF-).

entityType'JOB' | 'CLIENT'

The entity type of the custom field.

namestring

The name of the custom field.

type'Text' | 'Number' | 'Date' | 'Drop Down' | 'Checkbox' | 'Large Text' | 'File Upload'

The type of the custom field.

optionsstring[]

The options of the custom field.

positionnumber

The position of the custom field.

requiredboolean

Indicates whether the custom field is required or not. (job only)

requiredCloseboolean

Indicates whether the custom field is required to close the job. (job only)

searchableboolean

Indicates whether the custom field is searchable or not.

Example response

{
  "id": "CF-eYLPK7198xVp6Z8q",
  "entityType": "JOB",
  "name": "Custom Field 1",
  "type": "Text",
  "groupId": "CFG-eYLPK7198xVp6Z8q",
  "jobTypes": [
    {
      "id": "JT-8718036049ec4c4d",
      "name": "Repair"
    }
  ],
  "options": [
    "option 1",
    "option 2",
    "option 3"
  ],
  "position": 1
}