DokumentasiEngagement 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 respons
id
string
wajib
default
boolean
name
string
wajib
description
string
wajib
fields
array of object
wajib
Tampilkan atribut turunan
fields.id
string
wajib
fields.name
string
wajib
fields.description
string
fields.type
string
wajib
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Tampilkan atribut turunan
fields.values.id
string
wajib
fields.values.value
string
wajib
fields.values.icon
string
wajib
fields.values.createdAt
string
wajib
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Tampilkan atribut turunan
allowedEntities.entityType
string
wajib
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
wajib
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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 permintaan
default
boolean
name
string
description
string
fields
array of object
Tampilkan parameter turunan
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
wajib
fields.description
string
fields.type
string
wajib
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
Tampilkan parameter turunan
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
Tampilkan parameter turunan
allowedEntities.entityType
string
wajib
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
wajib
Payload respons
id
string
wajib
default
boolean
name
string
wajib
description
string
wajib
fields
array of object
wajib
Tampilkan atribut turunan
fields.id
string
wajib
fields.name
string
wajib
fields.description
string
fields.type
string
wajib
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Tampilkan atribut turunan
fields.values.id
string
wajib
fields.values.value
string
wajib
fields.values.icon
string
wajib
fields.values.createdAt
string
wajib
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Tampilkan atribut turunan
allowedEntities.entityType
string
wajib
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
wajib
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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
Contoh kode
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-values/{summaryValueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'