DocumentazioneEngagement 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.
Payload della risposta
id
string
obbligatorio
default
boolean
name
string
obbligatorio
description
string
obbligatorio
fields
array of object
obbligatorio
Mostra attributi secondari
fields.id
string
obbligatorio
fields.name
string
obbligatorio
fields.description
string
fields.type
string
obbligatorio
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Mostra attributi secondari
fields.values.id
string
obbligatorio
fields.values.value
string
obbligatorio
fields.values.icon
string
obbligatorio
fields.values.createdAt
string
obbligatorio
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Mostra attributi secondari
allowedEntities.entityType
string
obbligatorio
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
obbligatorio
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
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
Payload della richiesta
default
boolean
name
string
description
string
fields
array of object
Mostra parametri secondari
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
obbligatorio
fields.description
string
fields.type
string
obbligatorio
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
Mostra parametri secondari
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
Mostra parametri secondari
allowedEntities.entityType
string
obbligatorio
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
obbligatorio
Payload della risposta
id
string
obbligatorio
default
boolean
name
string
obbligatorio
description
string
obbligatorio
fields
array of object
obbligatorio
Mostra attributi secondari
fields.id
string
obbligatorio
fields.name
string
obbligatorio
fields.description
string
fields.type
string
obbligatorio
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Mostra attributi secondari
fields.values.id
string
obbligatorio
fields.values.value
string
obbligatorio
fields.values.icon
string
obbligatorio
fields.values.createdAt
string
obbligatorio
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Mostra attributi secondari
allowedEntities.entityType
string
obbligatorio
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
obbligatorio
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
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
Esempio di codice
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-values/{summaryValueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'