Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Custom Fields Groups

Create a new Custom Fields Group

Creates a new Custom Fields Group and returns the created Custom Fields Group.

post/v2/customfieldsgroups

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

entityType'JOB' | 'CLIENT' required

The entity type of the custom fields group.

namestring required

The custom fields group name.

Example request

{
  "entityType": "JOB",
  "name": "Custom Fields Group 1"
}

Response

The created Custom Fields Group.

idstring

The ID of the custom fields group (prefix CFG-).

entityType'JOB' | 'CLIENT'

The entity type of the custom fields group.

namestring

The name of the custom fields group.

Example response

{
  "id": "CFG-eYLPK7198xVp6Z8q",
  "entityType": "JOB",
  "name": "Custom Fields Group 1"
}