Create Custom Field Folder

POST 
/custom-fields/folder

Create Custom Field Folder

info

Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.

Request

Version stringrequired

API Version

Available optionsv3

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 object

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.

locationIdstringrequired

Location Id

namestringrequired

Field name

Example (auto)

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