How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Entergram Custom Fields API

Workspace chat custom columns, ticket custom columns, selectable options, and workspace-shared chat custom field values.

Entergram Custom Fields API is one of 16 APIs that Entergram publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 22 operations across 10 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against the base URL https://api.entergram.com.

22 operations 10 paths 19 schemas 4 DELETE8 GET6 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.entergram.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Entergram Custom Fields API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Workspace-scoped PRO API key created in Entergram Settings Developers.

Paths & Operations 22

Across 10 paths, the API surfaces 22 operations — 4 DELETE, 8 GET, 6 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Fields 22

Workspace chat custom columns, ticket custom columns, selectable options, and workspace-shared chat custom field values.

GET
/v1/chats/{chat_id}/custom-fields
Get workspace-shared custom field values for a chat
get-chat-custom-fields 1 param → 200401403404422500
PATCH
/v1/chats/{chat_id}/custom-fields
Patch workspace-shared custom field values for a chat
patch-chat-custom-fields 1 param body → 200400401403404422500
GET
/v1/custom-columns
List workspace chat custom columns
list-custom-columns → 200401403500
POST
/v1/custom-columns
Create a workspace chat custom column
create-custom-column body → 201400401403409422500
DELETE
/v1/custom-columns/{column_id}
Delete a workspace chat custom column
delete-custom-column 1 param → 200401403404422500
GET
/v1/custom-columns/{column_id}
Get a workspace chat custom column
get-custom-column 1 param → 200401403404422500
PATCH
/v1/custom-columns/{column_id}
Update a workspace chat custom column
update-custom-column 1 param body → 200400401403404409422500
GET
/v1/custom-columns/{column_id}/options
List workspace chat custom-column options
list-custom-column-options 1 param → 200401403404422500
POST
/v1/custom-columns/{column_id}/options
Create a workspace chat custom-column option
create-custom-column-option 1 param body → 201400401403404422500
DELETE
/v1/custom-columns/{column_id}/options/{option_id}
Delete a workspace chat custom-column option
delete-custom-column-option 2 params → 200401403404422500
PATCH
/v1/custom-columns/{column_id}/options/{option_id}
Update a workspace chat custom-column option
update-custom-column-option 2 params body → 200400401403404422500
GET
/v1/personal/chats/{chat_id}/custom-fields
Get actor-scoped custom field values for a chat
get-personal-chat-custom-fields 1 param → 200401403404422500
PATCH
/v1/personal/chats/{chat_id}/custom-fields
Patch actor-scoped custom field values for a chat
patch-personal-chat-custom-fields 1 param body → 200400401403404422500
GET
/v1/ticket-custom-columns
List workspace ticket custom columns
list-ticket-custom-columns → 200401403500
POST
/v1/ticket-custom-columns
Create a workspace ticket custom column
create-ticket-custom-column body → 201400401403409422500
DELETE
/v1/ticket-custom-columns/{column_id}
Delete a workspace ticket custom column
delete-ticket-custom-column 1 param → 200401403404422500
GET
/v1/ticket-custom-columns/{column_id}
Get a workspace ticket custom column
get-ticket-custom-column 1 param → 200401403404422500
PATCH
/v1/ticket-custom-columns/{column_id}
Update a workspace ticket custom column
update-ticket-custom-column 1 param body → 200400401403404409422500
GET
/v1/ticket-custom-columns/{column_id}/options
List workspace ticket custom-column options
list-ticket-custom-column-options 1 param → 200401403404422500
POST
/v1/ticket-custom-columns/{column_id}/options
Create a workspace ticket custom-column option
create-ticket-custom-column-option 1 param body → 201400401403404422500
DELETE
/v1/ticket-custom-columns/{column_id}/options/{option_id}
Delete a workspace ticket custom-column option
delete-ticket-custom-column-option 2 params → 200401403404422500
PATCH
/v1/ticket-custom-columns/{column_id}/options/{option_id}
Update a workspace ticket custom-column option
update-ticket-custom-column-option 2 params body → 200400401403404422500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are FieldColumnSummary (10 properties), CreateColumnBody (7 properties), UpdateColumnBody (6 properties), FieldOptionSummary (6 properties). Each schema is shown below with its type and property counts.

ChatCustomFieldsEnvelope
object
1 property 1 required
OptionsList
object
1 property 1 required
CreateOptionBody
object
3 properties 2 required
FieldColumnSummary
object
10 properties 9 required
UpdateColumnBody
object
6 properties
ErrorDetail
object
3 properties
ColumnsEnvelope
object
1 property 1 required
DeletedResource
object
1 property 1 required
OptionEnvelope
object
1 property 1 required
CreateColumnBody
object
7 properties 2 required
ColumnsList
object
1 property 1 required
DeletedEnvelope
object
1 property 1 required
FieldOptionSummary
object
6 properties 6 required
ErrorModel
object
6 properties
PatchChatCustomFieldsBody
object
1 property 1 required
OptionsEnvelope
object
1 property 1 required
ChatCustomFieldsResource
object
2 properties 2 required
ColumnEnvelope
object
1 property 1 required
UpdateOptionBody
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

entergram-custom-fields-api-openapi.yml Raw ↑

Other APIs Entergram publishes across the network.

Entergram Accounts API
Entergram Chat Commands API
Entergram Chats API
Entergram Contacts API
Entergram Events API
Entergram Groups API
Entergram Live Chats API
Entergram Make webhooks API
Entergram Members API
Entergram Messages API
Entergram System API
Entergram Tickets API
Where this information came from

This is an independent, third-party profile of Entergram Custom Fields API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.