latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Custom Fields

Create Custom Field

Create a new custom field belonging to the provided organization.

post/custom_fields

Request body

namestring required

The name of the custom field.

agentVisibleboolean required

Whether the custom field is visible to agents.

organizationIdstring required

The organization this custom field is scoped to.

Response

Returns the created custom field.

idstring required

The ID of the custom field.

type'custom_field' required

The type of object the attached ID corresponds to.

namestring required

The name of the custom field.

agentVisibleboolean required

Whether the custom field is visible to agents.

organizationIdstring

The organization this custom field is scoped to (if any).

createdAtstring required

An ISO-8601 string representing the date the custom field was created.