DocumentaciónEngagement Platform API
Sign inGet started
Guides
API

Ticket fields

GET
/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}
Retrieves a single summary settings by id for dynamic fields.
Cuerpo de la respuesta
id
string
obligatorio
default
boolean
name
string
obligatorio
description
string
obligatorio
fields
array of object
obligatorio
Mostrar atributos secundarios
fields.id
string
obligatorio
fields.name
string
obligatorio
fields.description
string
fields.type
string
obligatorio
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Mostrar atributos secundarios
fields.values.id
string
obligatorio
fields.values.value
string
obligatorio
fields.values.icon
string
obligatorio
fields.values.createdAt
string
obligatorio
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Mostrar atributos secundarios
allowedEntities.entityType
string
obligatorio
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
obligatorio
createdAt
string
obligatorio
updatedAt
string
obligatorio
Ejemplo de código
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}
Updates a summary settings for dynamic fields
Cuerpo de la solicitud
default
boolean
name
string
description
string
fields
array of object
Mostrar parámetros secundarios
fields.id
string
Should be specified if this field is being updated instead of created. When id is specified, type cannot be changed. By specifying the id, fields that are updated will continue to match the same attributes when searching.
fields.name
string
obligatorio
fields.description
string
fields.type
string
obligatorio
Possible values: single, multiple, numeric, text, boolean, date
fields.valueIds
array of string
Use values field instead. valueIds is the previous behaviour where values needed to be created upfront in another endpoint.
fields.values
array of object
Mostrar parámetros secundarios
fields.values.id
string
If specified, it will update this value. If not, it will create a new value and generate an id for it.
fields.values.value
string
fields.values.icon
string
fields.items
string
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Mostrar parámetros secundarios
allowedEntities.entityType
string
obligatorio
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
obligatorio
Cuerpo de la respuesta
id
string
obligatorio
default
boolean
name
string
obligatorio
description
string
obligatorio
fields
array of object
obligatorio
Mostrar atributos secundarios
fields.id
string
obligatorio
fields.name
string
obligatorio
fields.description
string
fields.type
string
obligatorio
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Mostrar atributos secundarios
fields.values.id
string
obligatorio
fields.values.value
string
obligatorio
fields.values.icon
string
obligatorio
fields.values.createdAt
string
obligatorio
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Mostrar atributos secundarios
allowedEntities.entityType
string
obligatorio
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
obligatorio
createdAt
string
obligatorio
updatedAt
string
obligatorio
Ejemplo de código
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/dynamic-fields-summary-values/{summaryValueId}
Deletes the specific summary value for dynamic fields
Ejemplo de código
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-values/{summaryValueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'