DokumentacjaEngagement 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.
Treść odpowiedzi
id
string
wymagane
default
boolean
name
string
wymagane
description
string
wymagane
fields
array of object
wymagane
Pokaż atrybuty podrzędne
fields.id
string
wymagane
fields.name
string
wymagane
fields.description
string
fields.type
string
wymagane
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Pokaż atrybuty podrzędne
fields.values.id
string
wymagane
fields.values.value
string
wymagane
fields.values.icon
string
wymagane
fields.values.createdAt
string
wymagane
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Pokaż atrybuty podrzędne
allowedEntities.entityType
string
wymagane
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
wymagane
createdAt
string
wymagane
updatedAt
string
wymagane
Przykład kodu
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
Treść żądania
default
boolean
name
string
description
string
fields
array of object
Pokaż parametry podrzędne
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
wymagane
fields.description
string
fields.type
string
wymagane
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
Pokaż parametry podrzędne
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
Pokaż parametry podrzędne
allowedEntities.entityType
string
wymagane
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
wymagane
Treść odpowiedzi
id
string
wymagane
default
boolean
name
string
wymagane
description
string
wymagane
fields
array of object
wymagane
Pokaż atrybuty podrzędne
fields.id
string
wymagane
fields.name
string
wymagane
fields.description
string
fields.type
string
wymagane
Possible values: single, multiple, numeric, text, boolean, date
fields.values
array of object
Pokaż atrybuty podrzędne
fields.values.id
string
wymagane
fields.values.value
string
wymagane
fields.values.icon
string
wymagane
fields.values.createdAt
string
wymagane
fields.settings
object
useLocalValues
boolean
allowedEntities
array of object
Pokaż atrybuty podrzędne
allowedEntities.entityType
string
wymagane
Possible values: team, agent
allowedEntities.operation
string
Possible values: view, edit
allowedEntities.entityId
string
wymagane
createdAt
string
wymagane
updatedAt
string
wymagane
Przykład kodu
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
Przykład kodu
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/dynamic-fields-summary-values/{summaryValueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'