Sign in
latestOpenAPI 3.0.32026-08-22149327338.9 KB

d4db007b26b2

custom-fields

Create a custom field

Creates a new custom field definition for the specified object type.

Rate limit: 20 requests per minute

post/custom-fields

Request body

default_valuestring

The default value for single-valued custom fields.

default_valuesstring[]

The default values for multi-valued custom fields.

descriptionstring

The description of the custom field.

labelstring required

The label of the custom field.

object_type'account' | 'issue' | 'contact' | 'task' | 'project' | 'meeting' | 'opportunity' required

The object type of the custom field. Can be "account", "issue", "contact", "task", "project", "meeting", or "opportunity".

slugstring

The slug of the custom field.

typestring required

The type of the custom field. Can be one of text, number, decimal, boolean, date, datetime, user, url, select, or multiselect.

Example request

{
  "object_type": "account",
  "type": "text"
}

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": {
    "object_type": "account",
    "type": "text"
  }
}