Create Custom Field Folder

POST 
/custom-fields/folder

Create Custom Field Folder.

info

Supports Custom Objects, Company (Business), and Project Management tasks (objectKey: "task", optional scopes). Contact and Opportunity fields continue to use the Locations custom-fields endpoints.

Request

Version stringrequired

API Version

Available options2021-07-28

application/json

application/json

Body

Bodyrequired

objectKeystringrequired

The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

namestringrequired

Field name

locationIdstringrequired

Location Id

Example (auto)

{
  "objectKey": "custom_object.pet",
  "name": "Name",
  "locationId": "ve9EPM428h8vShlRW1KT"
}

application/json

Successful response

application/json

Schema

Schema

idstringrequired

Unique identifier of the folder

objectKeystringrequired

The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

originIdstringrequired

Origin ID of the object

locationIdstringrequired

Location Id

namestringrequired

Field name

Example (auto)

{
  "id": "661c06b4ffde146bdb469442",
  "objectKey": "custom_object.pet",
  "originId": "661c06b4ffde146bdb469442",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "Name"
}