文档Engagement 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.
响应载荷
id
string
必填
default
boolean
name
string
必填
description
string
必填
fields
array of object
必填
显示子属性
fields.id
string
必填
fields.name
string
必填
fields.description
string
fields.type
string
必填
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
显示子属性
fields.values.id
string
必填
fields.values.value
string
必填
fields.values.icon
string
必填
fields.values.createdAt
string
必填
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
显示子属性
allowedEntities.entityType
string
必填
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
必填
createdAt
string
必填
updatedAt
string
必填
代码示例
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
请求载荷
default
boolean
name
string
description
string
fields
array of object
显示子参数
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
必填
fields.description
string
fields.type
string
必填
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
显示子参数
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
显示子参数
allowedEntities.entityType
string
必填
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
必填
响应载荷
id
string
必填
default
boolean
name
string
必填
description
string
必填
fields
array of object
必填
显示子属性
fields.id
string
必填
fields.name
string
必填
fields.description
string
fields.type
string
必填
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
显示子属性
fields.values.id
string
必填
fields.values.value
string
必填
fields.values.icon
string
必填
fields.values.createdAt
string
必填
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
显示子属性
allowedEntities.entityType
string
必填
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
必填
createdAt
string
必填
updatedAt
string
必填
代码示例
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
代码示例
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-values/{summaryValueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'