Feeds
Create feed
Create a custom feed or view feed for a given workspace.
POST/workspaces/{workspaceId}/feeds
Authorization
Path parameters
workspaceId*string
Body
indexType*enum
customviewprivateview
name*string
emojistring
querySearchFeedItemsRequest (object)
itemListOptionsnullable FeedItemListOptions (object)
accessEntitiesarray of AccessEntity (object)
Response
OK
Body
id*string
indexType*string
indexId*string
name*string
emojistring
querySearchFeedItemsRequest (object)
itemListOptionsnullable FeedItemListOptions (object)
accessEntitiesarray of AccessEntity (object)
itemCount*integer
Request
const response = await fetch('/workspaces/{workspaceId}/feeds', {
method: 'POST',
headers: {
"Authorization": "Bearer jwt",
"Content-Type": "application/json"
},
body: JSON.stringify({
"indexType": "custom",
"name": "text"
}),
});
const data = await response.json();Response
{
"id": "text",
"indexType": "text",
"indexId": "text",
"name": "text",
"emoji": "text",
"query": {
"conversationIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"sort": "createdAt",
"countOnly": false,
"indexType": "channel",
"indexId": "text",
"itemIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ticketNumbers": [
0
],
"itemType": "conversation",
"itemTypes": [
"conversation"
],
"agentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"teamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"closed": false,
"archived": false,
"replyStatus": "noFollowUp",
"seen": false,
"tagIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"conversationName": "text",
"conversationStatuses": [
"active"
],
"conferenceStatuses": [
"accepted"
],
"participants": {
"contacts": [
"123e4567-e89b-12d3-a456-426614174000"
],
"agents": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"conversationParticipantTypes": [
"user"
],
"conversationExcludeParticipantTypes": [
"user"
],
"conversationLastMessageSenderParticipantTypes": [
"user"
],
"fromContact": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"selectedValueIds": [
"text"
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21",
"valueDateBefore": "2024-12-21",
"valueDateAfter": "2024-12-21"
}
]
},
"conferenceId": "123e4567-e89b-12d3-a456-426614174000",
"itemStatuses": [
"open"
],
"dateFrom": "2024-12-21T11:59:49.587Z",
"dateTo": "2024-12-21T11:59:49.587Z",
"searchTerm": "text",
"slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
"hasSlaPolicy": false,
"slaPolicyStatus": "ok",
"slaMetric": "firstReplyTime",
"query": {
"operator": "and",
"children": []
},
"spam": false
},
"itemListOptions": {
"sort": "createdAt",
"reverse": false,
"columns": [
"contact"
]
},
"accessEntities": [
{
"entityId": "123e4567-e89b-12d3-a456-426614174000",
"entityType": "inbox-team"
}
],
"itemCount": 0
}List User Defined Feeds
Retrieve a list of custom and view feeds for administration purposes.
GET/workspaces/{workspaceId}/feeds
Authorization
Path parameters
workspaceId*string
Query parameters
Response
ok
Body
results*array of Feed (object)
Request
const response = await fetch('/workspaces/{workspaceId}/feeds', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"results": [
{
"id": "text",
"indexType": "text",
"indexId": "text",
"name": "text",
"emoji": "text",
"query": {
"conversationIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"sort": "createdAt",
"countOnly": false,
"indexType": "channel",
"indexId": "text",
"itemIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ticketNumbers": [
0
],
"itemType": "conversation",
"itemTypes": [
"conversation"
],
"agentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"teamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"closed": false,
"archived": false,
"replyStatus": "noFollowUp",
"seen": false,
"tagIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"conversationName": "text",
"conversationStatuses": [
"active"
],
"conferenceStatuses": [
"accepted"
],
"participants": {
"contacts": [
"123e4567-e89b-12d3-a456-426614174000"
],
"agents": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"conversationParticipantTypes": [
"user"
],
"conversationExcludeParticipantTypes": [
"user"
],
"conversationLastMessageSenderParticipantTypes": [
"user"
],
"fromContact": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"selectedValueIds": [
"text"
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21",
"valueDateBefore": "2024-12-21",
"valueDateAfter": "2024-12-21"
}
]
},
"conferenceId": "123e4567-e89b-12d3-a456-426614174000",
"itemStatuses": [
"open"
],
"dateFrom": "2024-12-21T11:59:49.587Z",
"dateTo": "2024-12-21T11:59:49.587Z",
"searchTerm": "text",
"slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
"hasSlaPolicy": false,
"slaPolicyStatus": "ok",
"slaMetric": "firstReplyTime",
"query": {
"operator": "and",
"children": []
},
"spam": false
},
"itemListOptions": {
"sort": "createdAt",
"reverse": false,
"columns": [
"contact"
]
},
"accessEntities": [
{
"entityId": "123e4567-e89b-12d3-a456-426614174000",
"entityType": "inbox-team"
}
],
"itemCount": 0
}
]
}Search feed items
Retrieve a list of feed items based on the specified parameters.
POST/workspaces/{workspaceId}/search/feed-items
Authorization
Path parameters
workspaceId*string
Query parameters
Body
conversationIdsarray of string (uuid)
sortenum
createdAtlastActivitylastMessageByContactslaExpires
countOnlyboolean
Return only the count of the results, not the results themselves
indexTypeenum
channelparticipantteamagentcustomtask
indexIdstring
itemIdsarray of string (uuid)
ticketNumbersarray of number
itemTypeenum
conversationconferencetask
itemTypesarray of enum
agentIdsarray of one of
teamIdsarray of string (uuid)
closedboolean
archivedboolean
replyStatusenum
noFollowUpnoCustomerReplynoAgentReply
seenboolean
tagIdsarray of string (uuid)
conversationNamestring
conversationStatusesarray of enum
conferenceStatusesarray of enum
participantsobject
conversationParticipantTypesarray of ParticipantType (enum)
conversationExcludeParticipantTypesarray of ParticipantType (enum)
conversationLastMessageSenderParticipantTypesarray of ParticipantType (enum)
fromContactone of
dynamicFieldsnullable UpdateSummaryForm (object)
conferenceIdstring (uuid)
itemStatusesarray of enum
dateFromstring (date-time)
dateTostring (date-time)
searchTermstring
slaPolicyIdstring (uuid)
hasSlaPolicyboolean
slaPolicyStatusSlaPolicyStatus (enum)
Reflects the overall state of the SLA policy on a ticket.
ok: all metrics are green.needsAttention: one or more metrics are in a warning state.breached: one or more metrics are in a breached state.
okneedsAttentionbreached
slaMetricSlaMetric (enum)
firstReplyTimenextReplyTime
queryAnyPredicate (any of)
spamboolean
If true, only return spam. Otherwise, only non-spam.
Response
ok
Body
resultsarray of Item (object)
totalnumber
The total number of results across all pages.
nextPageTokenstring
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
totalinteger
The total number of results across all pages.
Request
const response = await fetch('/workspaces/{workspaceId}/search/feed-items', {
method: 'POST',
headers: {
"Authorization": "Bearer jwt",
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();Response
{
"results": [
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
}
],
"total": 0,
"nextPageToken": "text"
}Search feed items
Retrieve a list of feed items based on the specified parameters.
GET/workspaces/{workspaceId}/search/feed-items
Authorization
Path parameters
workspaceId*string
Query parameters
Response
ok
Body
resultsarray of Item (object)
totalnumber
The total number of results across all pages.
nextPageTokenstring
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
totalinteger
The total number of results across all pages.
Request
const response = await fetch('/workspaces/{workspaceId}/search/feed-items', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"results": [
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
}
],
"total": 0,
"nextPageToken": "text"
}Get feed for a channel, participant or team
Retrieve the feed for a specific channel, participant, or team, containing updates, and interactions.
GET/workspaces/{workspaceId}/feeds/{feedId}
Authorization
Path parameters
workspaceId*string
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Response
OK
Body
id*string
indexType*string
indexId*string
name*string
emojistring
querySearchFeedItemsRequest (object)
itemListOptionsnullable FeedItemListOptions (object)
accessEntitiesarray of AccessEntity (object)
itemCount*integer
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"id": "text",
"indexType": "text",
"indexId": "text",
"name": "text",
"emoji": "text",
"query": {
"conversationIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"sort": "createdAt",
"countOnly": false,
"indexType": "channel",
"indexId": "text",
"itemIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ticketNumbers": [
0
],
"itemType": "conversation",
"itemTypes": [
"conversation"
],
"agentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"teamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"closed": false,
"archived": false,
"replyStatus": "noFollowUp",
"seen": false,
"tagIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"conversationName": "text",
"conversationStatuses": [
"active"
],
"conferenceStatuses": [
"accepted"
],
"participants": {
"contacts": [
"123e4567-e89b-12d3-a456-426614174000"
],
"agents": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"conversationParticipantTypes": [
"user"
],
"conversationExcludeParticipantTypes": [
"user"
],
"conversationLastMessageSenderParticipantTypes": [
"user"
],
"fromContact": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"selectedValueIds": [
"text"
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21",
"valueDateBefore": "2024-12-21",
"valueDateAfter": "2024-12-21"
}
]
},
"conferenceId": "123e4567-e89b-12d3-a456-426614174000",
"itemStatuses": [
"open"
],
"dateFrom": "2024-12-21T11:59:49.587Z",
"dateTo": "2024-12-21T11:59:49.587Z",
"searchTerm": "text",
"slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
"hasSlaPolicy": false,
"slaPolicyStatus": "ok",
"slaMetric": "firstReplyTime",
"query": {
"operator": "and",
"children": []
},
"spam": false
},
"itemListOptions": {
"sort": "createdAt",
"reverse": false,
"columns": [
"contact"
]
},
"accessEntities": [
{
"entityId": "123e4567-e89b-12d3-a456-426614174000",
"entityType": "inbox-team"
}
],
"itemCount": 0
}Updates Feed
Perform an update on a given feed.
PATCH/workspaces/{workspaceId}/feeds/{feedId}
Authorization
Path parameters
workspaceId*string
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Body
namestring
emojistring
querySearchFeedItemsRequest (object)
itemListOptionsnullable FeedItemListOptions (object)
accessEntitiesarray of AccessEntity (object)
Response
OK
Body
id*string
indexType*string
indexId*string
name*string
emojistring
querySearchFeedItemsRequest (object)
itemListOptionsnullable FeedItemListOptions (object)
accessEntitiesarray of AccessEntity (object)
itemCount*integer
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}', {
method: 'PATCH',
headers: {
"Authorization": "Bearer jwt",
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();Response
{
"id": "text",
"indexType": "text",
"indexId": "text",
"name": "text",
"emoji": "text",
"query": {
"conversationIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"sort": "createdAt",
"countOnly": false,
"indexType": "channel",
"indexId": "text",
"itemIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ticketNumbers": [
0
],
"itemType": "conversation",
"itemTypes": [
"conversation"
],
"agentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"teamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"closed": false,
"archived": false,
"replyStatus": "noFollowUp",
"seen": false,
"tagIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"conversationName": "text",
"conversationStatuses": [
"active"
],
"conferenceStatuses": [
"accepted"
],
"participants": {
"contacts": [
"123e4567-e89b-12d3-a456-426614174000"
],
"agents": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"conversationParticipantTypes": [
"user"
],
"conversationExcludeParticipantTypes": [
"user"
],
"conversationLastMessageSenderParticipantTypes": [
"user"
],
"fromContact": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"selectedValueIds": [
"text"
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21",
"valueDateBefore": "2024-12-21",
"valueDateAfter": "2024-12-21"
}
]
},
"conferenceId": "123e4567-e89b-12d3-a456-426614174000",
"itemStatuses": [
"open"
],
"dateFrom": "2024-12-21T11:59:49.587Z",
"dateTo": "2024-12-21T11:59:49.587Z",
"searchTerm": "text",
"slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
"hasSlaPolicy": false,
"slaPolicyStatus": "ok",
"slaMetric": "firstReplyTime",
"query": {
"operator": "and",
"children": []
},
"spam": false
},
"itemListOptions": {
"sort": "createdAt",
"reverse": false,
"columns": [
"contact"
]
},
"accessEntities": [
{
"entityId": "123e4567-e89b-12d3-a456-426614174000",
"entityType": "inbox-team"
}
],
"itemCount": 0
}Delete Feed
Permanently delete a feed.
DELETE/workspaces/{workspaceId}/feeds/{feedId}
Authorization
Path parameters
workspaceId*string
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Response
Deleted
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}', {
method: 'DELETE',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"code": "text",
"message": "text"
}List items for a channel, participant or team feed
Obtain a list of items within the feed.
GET/workspaces/{workspaceId}/feeds/{feedId}/items
Authorization
Path parameters
workspaceId*string
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Query parameters
Response
OK
Body
resultsarray of Item (object)
totalnumber
The total number of results across all pages.
nextPageTokenstring
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
totalinteger
The total number of results across all pages.
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"results": [
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
}
],
"total": 0,
"nextPageToken": "text"
}Updates items from a feed
Perform bulk updates on multiple items within a feed, modifying their content, status, or other attributes.
PATCH/workspaces/{workspaceId}/feeds/{feedId}/items
Authorization
Path parameters
workspaceId*string
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Body
agentIdnullable string
Response
Accepted
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items', {
method: 'PATCH',
headers: {
"Authorization": "Bearer jwt",
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();Response
{
"code": "text",
"message": "text"
}Get individual feed for logged in agent
Retrieve the feed for currently logged in agent.
GET/workspaces/{workspaceId}/me/feeds/{alias}
Authorization
Path parameters
workspaceId*string
alias*string
Response
OK
Body
id*string
indexType*string
indexId*string
name*string
emojistring
querySearchFeedItemsRequest (object)
itemListOptionsnullable FeedItemListOptions (object)
accessEntitiesarray of AccessEntity (object)
itemCount*integer
Request
const response = await fetch('/workspaces/{workspaceId}/me/feeds/{alias}', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"id": "text",
"indexType": "text",
"indexId": "text",
"name": "text",
"emoji": "text",
"query": {
"conversationIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"sort": "createdAt",
"countOnly": false,
"indexType": "channel",
"indexId": "text",
"itemIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ticketNumbers": [
0
],
"itemType": "conversation",
"itemTypes": [
"conversation"
],
"agentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"teamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"closed": false,
"archived": false,
"replyStatus": "noFollowUp",
"seen": false,
"tagIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"conversationName": "text",
"conversationStatuses": [
"active"
],
"conferenceStatuses": [
"accepted"
],
"participants": {
"contacts": [
"123e4567-e89b-12d3-a456-426614174000"
],
"agents": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"conversationParticipantTypes": [
"user"
],
"conversationExcludeParticipantTypes": [
"user"
],
"conversationLastMessageSenderParticipantTypes": [
"user"
],
"fromContact": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"selectedValueIds": [
"text"
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21",
"valueDateBefore": "2024-12-21",
"valueDateAfter": "2024-12-21"
}
]
},
"conferenceId": "123e4567-e89b-12d3-a456-426614174000",
"itemStatuses": [
"open"
],
"dateFrom": "2024-12-21T11:59:49.587Z",
"dateTo": "2024-12-21T11:59:49.587Z",
"searchTerm": "text",
"slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
"hasSlaPolicy": false,
"slaPolicyStatus": "ok",
"slaMetric": "firstReplyTime",
"query": {
"operator": "and",
"children": []
},
"spam": false
},
"itemListOptions": {
"sort": "createdAt",
"reverse": false,
"columns": [
"contact"
]
},
"accessEntities": [
{
"entityId": "123e4567-e89b-12d3-a456-426614174000",
"entityType": "inbox-team"
}
],
"itemCount": 0
}List items for logged in agent's individual feed
Obtain a list of items within the feed of currently logged in agent.
GET/workspaces/{workspaceId}/me/feeds/{alias}/items
Authorization
Path parameters
workspaceId*string
alias*string
Query parameters
Response
OK
Body
resultsarray of Item (object)
totalnumber
The total number of results across all pages.
nextPageTokenstring
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
totalinteger
The total number of results across all pages.
Request
const response = await fetch('/workspaces/{workspaceId}/me/feeds/{alias}/items', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"results": [
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
}
],
"total": 0,
"nextPageToken": "text"
}Get Feed Item By a specific filter
Retrieve information about a specific item.
GET/workspaces/{workspaceId}/feeds/items
Authorization
Path parameters
workspaceId*string
Query parameters
Response
OK
Body
idstring
feedIdstring
feedIndexIdstring
feedIndexTypestring
typeenum
conversationconference
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/items?ticketNumber=0', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"type": "conversation"
}Get Feed Item By Root Item ID
Retrieve information about a specific item.
GET/workspaces/{workspaceId}/feeds/items/{itemId}
Authorization
Path parameters
workspaceId*string
itemId*string
Feed Item UUID
Response
OK
Body
idstring
feedIdstring
feedIndexIdstring
feedIndexTypestring
typeenum
conversationconference
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/items/{itemId}', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"type": "conversation"
}Get Feed Item
Retrieve information about a specific item within a feed.
GET/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Authorization
Path parameters
workspaceId*string
itemId*string
Feed Item UUID
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Response
OK
Body
id*string
feedIdstring
feedIndexIdstring
feedIndexTypestring
agentFeedItemAssignee (object)
teamFeedItemAssignee (object)
numberinteger
type*enum
conversationconferencetask
archived*boolean
closed*boolean
privateboolean
deletedboolean
spamboolean
seenboolean
seenBystring (uuid)
replySuggestionstring
createdAt*string (date-time)
willBeDeletedAtstring (date-time)
lastActivityAt*string (date-time)
lastMessageByContactAtstring (date-time)
tagsarray of FeedItemTag (object)
attributesFeedItemAttributes (array of object)
filtersFeedItemFilters (array of FeedItemAttributes (array of object))
linkedItemsarray of LinkedItem (object)
mergeInfoobject
dynamicFieldsSummaryForm (object)
summaryFormSummaryForm (object)
queueInfoFeedItemQueueInfo (object)
conversationany of
conferenceany of
tasknullable object
slaPolicySlaPolicyInfo (object)
requiredSkillsarray of AgentAssignedSkill (object)
statusstring
The slug that identifies the status of the root item.
statusCategoryRootItemStatusCategory (enum)
The category maps to the lifecycle of a root item in the system.
newinProgresspendingclosed
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}', {
method: 'GET',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
}Update Feed Item
Modify the content of a specific item within a feed.
PATCH/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Authorization
Path parameters
workspaceId*string
itemId*string
Feed Item UUID
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Body
agentIdnullable string
teamIdnullable string
archivednullable boolean
spamnullable boolean
closednullable boolean
seenboolean
privatenullable boolean
replySuggestionstring
customAttributesnullable object
dynamicFieldsnullable UpdateSummaryForm (object)
summaryFormnullable UpdateSummaryForm (object)
slaPolicyIdnullable string (uuid)
requiredSkillsnullable array of AgentAssignedSkill (object)
statusstring
The slug of the status to set on the feed item.
Response
Updated
Body
id*string
feedIdstring
feedIndexIdstring
feedIndexTypestring
agentFeedItemAssignee (object)
teamFeedItemAssignee (object)
numberinteger
type*enum
conversationconferencetask
archived*boolean
closed*boolean
privateboolean
deletedboolean
spamboolean
seenboolean
seenBystring (uuid)
replySuggestionstring
createdAt*string (date-time)
willBeDeletedAtstring (date-time)
lastActivityAt*string (date-time)
lastMessageByContactAtstring (date-time)
tagsarray of FeedItemTag (object)
attributesFeedItemAttributes (array of object)
filtersFeedItemFilters (array of FeedItemAttributes (array of object))
linkedItemsarray of LinkedItem (object)
mergeInfoobject
dynamicFieldsSummaryForm (object)
summaryFormSummaryForm (object)
queueInfoFeedItemQueueInfo (object)
conversationany of
conferenceany of
tasknullable object
slaPolicySlaPolicyInfo (object)
requiredSkillsarray of AgentAssignedSkill (object)
statusstring
The slug that identifies the status of the root item.
statusCategoryRootItemStatusCategory (enum)
The category maps to the lifecycle of a root item in the system.
newinProgresspendingclosed
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}', {
method: 'PATCH',
headers: {
"Authorization": "Bearer jwt",
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();Response
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
}Add item to a feed
Add an existent item to an existent feed.
POST/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Authorization
Path parameters
workspaceId*string
itemId*string
Feed Item UUID
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Body
AddItemToFeed (object)
Response
Created
Body
id*string
feedIdstring
feedIndexIdstring
feedIndexTypestring
agentFeedItemAssignee (object)
teamFeedItemAssignee (object)
numberinteger
type*enum
conversationconferencetask
archived*boolean
closed*boolean
privateboolean
deletedboolean
spamboolean
seenboolean
seenBystring (uuid)
replySuggestionstring
createdAt*string (date-time)
willBeDeletedAtstring (date-time)
lastActivityAt*string (date-time)
lastMessageByContactAtstring (date-time)
tagsarray of FeedItemTag (object)
attributesFeedItemAttributes (array of object)
filtersFeedItemFilters (array of FeedItemAttributes (array of object))
linkedItemsarray of LinkedItem (object)
mergeInfoobject
dynamicFieldsSummaryForm (object)
summaryFormSummaryForm (object)
queueInfoFeedItemQueueInfo (object)
conversationany of
conferenceany of
tasknullable object
slaPolicySlaPolicyInfo (object)
requiredSkillsarray of AgentAssignedSkill (object)
statusstring
The slug that identifies the status of the root item.
statusCategoryRootItemStatusCategory (enum)
The category maps to the lifecycle of a root item in the system.
newinProgresspendingclosed
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}', {
method: 'POST',
headers: {
"Authorization": "Bearer jwt",
"Content-Type": "application/json"
},
});
const data = await response.json();Response
{
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
}Remove item from feed
Removes an item from a feed.
DELETE/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Authorization
Path parameters
workspaceId*string
itemId*string
Feed Item UUID
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Response
Deleted
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}', {
method: 'DELETE',
headers: {
"Authorization": "Bearer jwt"
},
});
const data = await response.json();Response
{
"code": "text",
"message": "text"
}Merges this feed item into another one
Merges the feed item in the URL into the one specified in the request body.
POST/workspaces/{workspaceId}/feeds/{feedId}/merge-items
Authorization
Path parameters
workspaceId*string
feedId*string
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Body
mergeFrom*MergeItem (object)
mergeInto*MergeItem (object)
Response
Ok
Body
mergedFrom*Item (object)
mergedInto*Item (object)
mergedFromMessageSentIdstring (uuid)
mergedIntoMessageSentIdstring (uuid)
mergedFromCommentCreatedIdstring (uuid)
mergedIntoCommentCreatedIdstring (uuid)
Request
const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/merge-items', {
method: 'POST',
headers: {
"Authorization": "Bearer jwt",
"Content-Type": "application/json"
},
body: JSON.stringify({
"mergeFrom": {
"itemId": "123e4567-e89b-12d3-a456-426614174000"
},
"mergeInto": {
"itemId": "123e4567-e89b-12d3-a456-426614174000"
}
}),
});
const data = await response.json();Response
{
"mergedFrom": {
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
},
"mergedInto": {
"id": "text",
"feedId": "text",
"feedIndexId": "text",
"feedIndexType": "text",
"agent": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"team": {
"id": "text",
"name": "text",
"avatarUrl": "text"
},
"number": 0,
"type": "conversation",
"archived": false,
"closed": false,
"private": false,
"deleted": false,
"spam": false,
"seen": false,
"seenBy": "123e4567-e89b-12d3-a456-426614174000",
"replySuggestion": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"willBeDeletedAt": "2024-12-21T11:59:49.587Z",
"lastActivityAt": "2024-12-21T11:59:49.587Z",
"lastMessageByContactAt": "2024-12-21T11:59:49.587Z",
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"status": "draft",
"addedAt": "2024-12-21T11:59:49.587Z",
"category": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"emoji": "text"
}
}
],
"attributes": [
{
"key": "text",
"value": "text"
}
],
"filters": [
[
{
"key": "text",
"value": "text"
}
]
],
"linkedItems": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"relation": "linkedTo",
"itemId": "123e4567-e89b-12d3-a456-426614174000",
"itemNumber": 0,
"itemSubject": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergeInfo": {
"mergedFrom": [
{
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
],
"mergedInto": {
"userId": "text",
"itemId": "text",
"createdAt": "2024-12-21T11:59:49.587Z"
}
},
"dynamicFields": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"summaryForm": {
"settingsId": "text",
"fields": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "single",
"values": [
{
"id": "text",
"value": "text",
"icon": "text",
"createdAt": "2024-12-21T11:59:49.587Z",
"selected": false
}
],
"valueText": "text",
"valueNumber": 0,
"valueBoolean": false,
"valueDate": "2024-12-21"
}
]
},
"queueInfo": {
"queueId": "123e4567-e89b-12d3-a456-426614174000",
"queueName": "text",
"queuedAt": "2024-12-21T11:59:49.587Z"
},
"conversation": {
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": false,
"likelySpamReason": "advertisement"
},
"slaPolicy": {
"policyId": "123e4567-e89b-12d3-a456-426614174000",
"timers": [
{
"metric": "firstReplyTime",
"severity": "breach",
"status": "inactive",
"expiresAt": "2024-12-21T11:59:49.587Z"
}
]
},
"requiredSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"status": "text",
"statusCategory": "new"
},
"mergedFromMessageSentId": "123e4567-e89b-12d3-a456-426614174000",
"mergedIntoMessageSentId": "123e4567-e89b-12d3-a456-426614174000",
"mergedFromCommentCreatedId": "123e4567-e89b-12d3-a456-426614174000",
"mergedIntoCommentCreatedId": "123e4567-e89b-12d3-a456-426614174000"
}Last updated