DocumentatieEngagement 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.
Antwoord-payload
id
string
verplicht
default
boolean
name
string
verplicht
description
string
verplicht
fields
array of object
verplicht
Onderliggende attributen tonen
fields.id
string
verplicht
fields.name
string
verplicht
fields.description
string
fields.type
string
verplicht
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Onderliggende attributen tonen
fields.values.id
string
verplicht
fields.values.value
string
verplicht
fields.values.icon
string
verplicht
fields.values.createdAt
string
verplicht
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Onderliggende attributen tonen
allowedEntities.entityType
string
verplicht
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
verplicht
createdAt
string
verplicht
updatedAt
string
verplicht
Codevoorbeeld
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
Verzoek-payload
default
boolean
name
string
description
string
fields
array of object
Onderliggende parameters tonen
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
verplicht
fields.description
string
fields.type
string
verplicht
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
Onderliggende parameters tonen
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
Onderliggende parameters tonen
allowedEntities.entityType
string
verplicht
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
verplicht
Antwoord-payload
id
string
verplicht
default
boolean
name
string
verplicht
description
string
verplicht
fields
array of object
verplicht
Onderliggende attributen tonen
fields.id
string
verplicht
fields.name
string
verplicht
fields.description
string
fields.type
string
verplicht
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Onderliggende attributen tonen
fields.values.id
string
verplicht
fields.values.value
string
verplicht
fields.values.icon
string
verplicht
fields.values.createdAt
string
verplicht
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Onderliggende attributen tonen
allowedEntities.entityType
string
verplicht
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
verplicht
createdAt
string
verplicht
updatedAt
string
verplicht
Codevoorbeeld
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
Codevoorbeeld
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-values/{summaryValueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'