Feeds

Create feed

Create a custom feed or view feed for a given workspace.

POST/workspaces/{workspaceId}/feeds

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

indexType*enum

customviewprivateview

name*string

emojistring

querySearchFeedItemsRequest (object)

itemListOptionsnullable FeedItemListOptions (object)

accessEntitiesarray of AccessEntity (object)

Response

201404422

OK

Body

application/json

id*string

indexType*string

indexId*string

name*string

emojistring

querySearchFeedItemsRequest (object)

itemListOptionsnullable FeedItemListOptions (object)

accessEntitiesarray of AccessEntity (object)

itemCount*integer

Request

JavaScriptCurlPython

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

201404422

{
  "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"
    ],
    "unassigned": false,
    "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-11-21",
          "valueDateBefore": "2024-11-21",
          "valueDateAfter": "2024-11-21"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2024-11-21T08:43:41.194Z",
    "dateTo": "2024-11-21T08:43:41.194Z",
    "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"
    }
  ]
}

List User Defined Feeds

Retrieve a list of custom and view feeds for administration purposes.

GET/workspaces/{workspaceId}/feeds

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404

ok

Body

application/json

results*array of Feed (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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"
        ],
        "unassigned": false,
        "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-11-21",
              "valueDateBefore": "2024-11-21",
              "valueDateAfter": "2024-11-21"
            }
          ]
        },
        "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
        "itemStatuses": [
          "open"
        ],
        "dateFrom": "2024-11-21T08:43:41.194Z",
        "dateTo": "2024-11-21T08:43:41.194Z",
        "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"
        }
      ]
    }
  ]
}

Search feed items

Retrieve a list of feed items based on the specified parameters.

POST/workspaces/{workspaceId}/search/feed-items

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Body

application/json

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

unassignedboolean

Search for feed items that have no agent assigned.

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

objectobject

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)

CompositionPredicate (object)AbsoluteDatePredicate (object)StringPredicate (object)NumberPredicate (object)BooleanPredicate (object)DynamicFieldsPredicate (object)

spamboolean

If true, only return spam. Otherwise, only non-spam.

Response

200404422

ok

Body

application/json

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

JavaScriptCurlPython

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

200404422

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "type": "conversation",
      "archived": false,
      "closed": false,
      "private": false,
      "deleted": false,
      "spam": false,
      "seen": false,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2024-11-21T08:43:41.194Z",
      "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
      "lastActivityAt": "2024-11-21T08:43:41.194Z",
      "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2024-11-21T08:43:41.194Z",
          "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",
          "itemSubject": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2024-11-21T08:43:41.194Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2024-11-21T08:43:41.194Z"
      },
      "conversation": {
        "id": "text",
        "name": "text",
        "description": "text",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "featuredParticipants": [
          {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          }
        ],
        "initiatingParticipant": {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        },
        "channelId": "123e4567-e89b-12d3-a456-426614174000",
        "lastMessage": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "preview": {
            "text": "text"
          },
          "status": "accepted",
          "sender": {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          },
          "recipients": [
            {
              "id": "text",
              "type": "to",
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text",
              "contactAnnotation": {
                "name": "text"
              }
            }
          ],
          "createdAt": "2024-11-21T08:43:41.194Z"
        },
        "createdAt": "2024-11-21T08:43:41.194Z",
        "updatedAt": "2024-11-21T08:43:41.194Z",
        "platformStyle": "direct",
        "referral": {
          "sourceUrl": "text",
          "sourceId": "text",
          "sourceType": "text",
          "mediaUrl": "text",
          "mediaType": "text",
          "caption": "text",
          "title": "text",
          "text": "text",
          "username": "text",
          "timestamp": "2024-11-21T08:43:41.194Z"
        }
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2024-11-21T08:43:41.194Z"
          }
        ]
      },
      "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

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404422

ok

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/search/feed-items', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404422

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "type": "conversation",
      "archived": false,
      "closed": false,
      "private": false,
      "deleted": false,
      "spam": false,
      "seen": false,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2024-11-21T08:43:41.194Z",
      "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
      "lastActivityAt": "2024-11-21T08:43:41.194Z",
      "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2024-11-21T08:43:41.194Z",
          "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",
          "itemSubject": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2024-11-21T08:43:41.194Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2024-11-21T08:43:41.194Z"
      },
      "conversation": {
        "id": "text",
        "name": "text",
        "description": "text",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "featuredParticipants": [
          {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          }
        ],
        "initiatingParticipant": {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        },
        "channelId": "123e4567-e89b-12d3-a456-426614174000",
        "lastMessage": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "preview": {
            "text": "text"
          },
          "status": "accepted",
          "sender": {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          },
          "recipients": [
            {
              "id": "text",
              "type": "to",
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text",
              "contactAnnotation": {
                "name": "text"
              }
            }
          ],
          "createdAt": "2024-11-21T08:43:41.194Z"
        },
        "createdAt": "2024-11-21T08:43:41.194Z",
        "updatedAt": "2024-11-21T08:43:41.194Z",
        "platformStyle": "direct",
        "referral": {
          "sourceUrl": "text",
          "sourceId": "text",
          "sourceType": "text",
          "mediaUrl": "text",
          "mediaType": "text",
          "caption": "text",
          "title": "text",
          "text": "text",
          "username": "text",
          "timestamp": "2024-11-21T08:43:41.194Z"
        }
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2024-11-21T08:43:41.194Z"
          }
        ]
      },
      "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

useraccessKey

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

200403404

OK

Body

application/json

id*string

indexType*string

indexId*string

name*string

emojistring

querySearchFeedItemsRequest (object)

itemListOptionsnullable FeedItemListOptions (object)

accessEntitiesarray of AccessEntity (object)

itemCount*integer

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200403404

{
  "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"
    ],
    "unassigned": false,
    "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-11-21",
          "valueDateBefore": "2024-11-21",
          "valueDateAfter": "2024-11-21"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2024-11-21T08:43:41.194Z",
    "dateTo": "2024-11-21T08:43:41.194Z",
    "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"
    }
  ]
}

Updates Feed

Perform an update on a given feed.

PATCH/workspaces/{workspaceId}/feeds/{feedId}

Authorization

useraccessKey

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

application/json

namestring

emojistring

querySearchFeedItemsRequest (object)

itemListOptionsnullable FeedItemListOptions (object)

accessEntitiesarray of AccessEntity (object)

Response

200403404422

OK

Body

application/json

id*string

indexType*string

indexId*string

name*string

emojistring

querySearchFeedItemsRequest (object)

itemListOptionsnullable FeedItemListOptions (object)

accessEntitiesarray of AccessEntity (object)

itemCount*integer

Request

JavaScriptCurlPython

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

200403404422

{
  "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"
    ],
    "unassigned": false,
    "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-11-21",
          "valueDateBefore": "2024-11-21",
          "valueDateAfter": "2024-11-21"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2024-11-21T08:43:41.194Z",
    "dateTo": "2024-11-21T08:43:41.194Z",
    "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"
    }
  ]
}

Delete Feed

Permanently delete a feed.

DELETE/workspaces/{workspaceId}/feeds/{feedId}

Authorization

useraccessKey

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

204403404422

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

403404422

{
  "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

useraccessKey

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

200403404

OK

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200403404

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "type": "conversation",
      "archived": false,
      "closed": false,
      "private": false,
      "deleted": false,
      "spam": false,
      "seen": false,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2024-11-21T08:43:41.194Z",
      "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
      "lastActivityAt": "2024-11-21T08:43:41.194Z",
      "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2024-11-21T08:43:41.194Z",
          "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",
          "itemSubject": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2024-11-21T08:43:41.194Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2024-11-21T08:43:41.194Z"
      },
      "conversation": {
        "id": "text",
        "name": "text",
        "description": "text",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "featuredParticipants": [
          {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          }
        ],
        "initiatingParticipant": {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        },
        "channelId": "123e4567-e89b-12d3-a456-426614174000",
        "lastMessage": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "preview": {
            "text": "text"
          },
          "status": "accepted",
          "sender": {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          },
          "recipients": [
            {
              "id": "text",
              "type": "to",
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text",
              "contactAnnotation": {
                "name": "text"
              }
            }
          ],
          "createdAt": "2024-11-21T08:43:41.194Z"
        },
        "createdAt": "2024-11-21T08:43:41.194Z",
        "updatedAt": "2024-11-21T08:43:41.194Z",
        "platformStyle": "direct",
        "referral": {
          "sourceUrl": "text",
          "sourceId": "text",
          "sourceType": "text",
          "mediaUrl": "text",
          "mediaType": "text",
          "caption": "text",
          "title": "text",
          "text": "text",
          "username": "text",
          "timestamp": "2024-11-21T08:43:41.194Z"
        }
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2024-11-21T08:43:41.194Z"
          }
        ]
      },
      "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

useraccessKey

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

application/json

agentIdnullable string

Response

202403404422

Accepted

Request

JavaScriptCurlPython

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

403404422

{
  "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

useraccessKey

Path parameters

workspaceId*string

alias*string

Response

200404

OK

Body

application/json

id*string

indexType*string

indexId*string

name*string

emojistring

querySearchFeedItemsRequest (object)

itemListOptionsnullable FeedItemListOptions (object)

accessEntitiesarray of AccessEntity (object)

itemCount*integer

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/me/feeds/{alias}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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"
    ],
    "unassigned": false,
    "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-11-21",
          "valueDateBefore": "2024-11-21",
          "valueDateAfter": "2024-11-21"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2024-11-21T08:43:41.194Z",
    "dateTo": "2024-11-21T08:43:41.194Z",
    "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"
    }
  ]
}

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

useraccessKey

Path parameters

workspaceId*string

alias*string

Query parameters

Response

200404

OK

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/me/feeds/{alias}/items', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "type": "conversation",
      "archived": false,
      "closed": false,
      "private": false,
      "deleted": false,
      "spam": false,
      "seen": false,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2024-11-21T08:43:41.194Z",
      "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
      "lastActivityAt": "2024-11-21T08:43:41.194Z",
      "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2024-11-21T08:43:41.194Z",
          "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",
          "itemSubject": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2024-11-21T08:43:41.194Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2024-11-21T08:43:41.194Z",
                "selected": false
              }
            ],
            "valueText": "text",
            "valueNumber": 0,
            "valueBoolean": false,
            "valueDate": "2024-11-21"
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2024-11-21T08:43:41.194Z"
      },
      "conversation": {
        "id": "text",
        "name": "text",
        "description": "text",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "featuredParticipants": [
          {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          }
        ],
        "initiatingParticipant": {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        },
        "channelId": "123e4567-e89b-12d3-a456-426614174000",
        "lastMessage": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "preview": {
            "text": "text"
          },
          "status": "accepted",
          "sender": {
            "id": "text",
            "displayName": "text",
            "avatarUrl": "text",
            "contact": {
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text"
            },
            "type": "user",
            "status": "pending"
          },
          "recipients": [
            {
              "id": "text",
              "type": "to",
              "identifierKey": "text",
              "identifierValue": "text",
              "platformAddress": "text",
              "platformAddressSelector": "text",
              "contactAnnotation": {
                "name": "text"
              }
            }
          ],
          "createdAt": "2024-11-21T08:43:41.194Z"
        },
        "createdAt": "2024-11-21T08:43:41.194Z",
        "updatedAt": "2024-11-21T08:43:41.194Z",
        "platformStyle": "direct",
        "referral": {
          "sourceUrl": "text",
          "sourceId": "text",
          "sourceType": "text",
          "mediaUrl": "text",
          "mediaType": "text",
          "caption": "text",
          "title": "text",
          "text": "text",
          "username": "text",
          "timestamp": "2024-11-21T08:43:41.194Z"
        }
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2024-11-21T08:43:41.194Z"
          }
        ]
      },
      "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

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

idstring

feedIdstring

feedIndexIdstring

feedIndexTypestring

typeenum

conversationconference

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/items', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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

useraccessKey

Path parameters

workspaceId*string

itemId*string

Feed Item UUID

Response

200404

OK

Body

application/json

idstring

feedIdstring

feedIndexIdstring

feedIndexTypestring

typeenum

conversationconference

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/items/{itemId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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

useraccessKey

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

200403404

OK

Body

application/json

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

Conversation (object)nullable object

conferenceany of

nullable objectnullable object

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

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200403404

{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "agent": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "team": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "type": "conversation",
  "archived": false,
  "closed": false,
  "private": false,
  "deleted": false,
  "spam": false,
  "seen": false,
  "seenBy": "123e4567-e89b-12d3-a456-426614174000",
  "replySuggestion": "text",
  "createdAt": "2024-11-21T08:43:41.194Z",
  "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
  "lastActivityAt": "2024-11-21T08:43:41.194Z",
  "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "status": "draft",
      "addedAt": "2024-11-21T08:43:41.194Z",
      "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",
      "itemSubject": "text",
      "createdAt": "2024-11-21T08:43:41.194Z"
    }
  ],
  "mergeInfo": {
    "mergedFrom": [
      {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2024-11-21T08:43:41.194Z"
      }
    ],
    "mergedInto": {
      "userId": "text",
      "itemId": "text",
      "createdAt": "2024-11-21T08:43:41.194Z"
    }
  },
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2024-11-21T08:43:41.194Z",
            "selected": false
          }
        ],
        "valueText": "text",
        "valueNumber": 0,
        "valueBoolean": false,
        "valueDate": "2024-11-21"
      }
    ]
  },
  "summaryForm": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2024-11-21T08:43:41.194Z",
            "selected": false
          }
        ],
        "valueText": "text",
        "valueNumber": 0,
        "valueBoolean": false,
        "valueDate": "2024-11-21"
      }
    ]
  },
  "queueInfo": {
    "queueId": "123e4567-e89b-12d3-a456-426614174000",
    "queueName": "text",
    "queuedAt": "2024-11-21T08:43:41.194Z"
  },
  "conversation": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "active",
    "visibility": "public",
    "accessibility": "open",
    "featuredParticipants": [
      {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      }
    ],
    "initiatingParticipant": {
      "id": "text",
      "displayName": "text",
      "avatarUrl": "text",
      "contact": {
        "identifierKey": "text",
        "identifierValue": "text",
        "platformAddress": "text",
        "platformAddressSelector": "text"
      },
      "type": "user",
      "status": "pending"
    },
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "lastMessage": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "preview": {
        "text": "text"
      },
      "status": "accepted",
      "sender": {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      },
      "recipients": [
        {
          "id": "text",
          "type": "to",
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text",
          "contactAnnotation": {
            "name": "text"
          }
        }
      ],
      "createdAt": "2024-11-21T08:43:41.194Z"
    },
    "createdAt": "2024-11-21T08:43:41.194Z",
    "updatedAt": "2024-11-21T08:43:41.194Z",
    "platformStyle": "direct",
    "referral": {
      "sourceUrl": "text",
      "sourceId": "text",
      "sourceType": "text",
      "mediaUrl": "text",
      "mediaType": "text",
      "caption": "text",
      "title": "text",
      "text": "text",
      "username": "text",
      "timestamp": "2024-11-21T08:43:41.194Z"
    }
  },
  "slaPolicy": {
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "timers": [
      {
        "metric": "firstReplyTime",
        "severity": "breach",
        "status": "inactive",
        "expiresAt": "2024-11-21T08:43:41.194Z"
      }
    ]
  },
  "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

useraccessKey

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

application/json

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

200403404409422

Updated

Body

application/json

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

Conversation (object)nullable object

conferenceany of

nullable objectnullable object

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

JavaScriptCurlPython

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

200403404409422

{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "agent": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "team": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "type": "conversation",
  "archived": false,
  "closed": false,
  "private": false,
  "deleted": false,
  "spam": false,
  "seen": false,
  "seenBy": "123e4567-e89b-12d3-a456-426614174000",
  "replySuggestion": "text",
  "createdAt": "2024-11-21T08:43:41.194Z",
  "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
  "lastActivityAt": "2024-11-21T08:43:41.194Z",
  "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "status": "draft",
      "addedAt": "2024-11-21T08:43:41.194Z",
      "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",
      "itemSubject": "text",
      "createdAt": "2024-11-21T08:43:41.194Z"
    }
  ],
  "mergeInfo": {
    "mergedFrom": [
      {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2024-11-21T08:43:41.194Z"
      }
    ],
    "mergedInto": {
      "userId": "text",
      "itemId": "text",
      "createdAt": "2024-11-21T08:43:41.194Z"
    }
  },
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2024-11-21T08:43:41.194Z",
            "selected": false
          }
        ],
        "valueText": "text",
        "valueNumber": 0,
        "valueBoolean": false,
        "valueDate": "2024-11-21"
      }
    ]
  },
  "summaryForm": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2024-11-21T08:43:41.194Z",
            "selected": false
          }
        ],
        "valueText": "text",
        "valueNumber": 0,
        "valueBoolean": false,
        "valueDate": "2024-11-21"
      }
    ]
  },
  "queueInfo": {
    "queueId": "123e4567-e89b-12d3-a456-426614174000",
    "queueName": "text",
    "queuedAt": "2024-11-21T08:43:41.194Z"
  },
  "conversation": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "active",
    "visibility": "public",
    "accessibility": "open",
    "featuredParticipants": [
      {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      }
    ],
    "initiatingParticipant": {
      "id": "text",
      "displayName": "text",
      "avatarUrl": "text",
      "contact": {
        "identifierKey": "text",
        "identifierValue": "text",
        "platformAddress": "text",
        "platformAddressSelector": "text"
      },
      "type": "user",
      "status": "pending"
    },
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "lastMessage": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "preview": {
        "text": "text"
      },
      "status": "accepted",
      "sender": {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      },
      "recipients": [
        {
          "id": "text",
          "type": "to",
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text",
          "contactAnnotation": {
            "name": "text"
          }
        }
      ],
      "createdAt": "2024-11-21T08:43:41.194Z"
    },
    "createdAt": "2024-11-21T08:43:41.194Z",
    "updatedAt": "2024-11-21T08:43:41.194Z",
    "platformStyle": "direct",
    "referral": {
      "sourceUrl": "text",
      "sourceId": "text",
      "sourceType": "text",
      "mediaUrl": "text",
      "mediaType": "text",
      "caption": "text",
      "title": "text",
      "text": "text",
      "username": "text",
      "timestamp": "2024-11-21T08:43:41.194Z"
    }
  },
  "slaPolicy": {
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "timers": [
      {
        "metric": "firstReplyTime",
        "severity": "breach",
        "status": "inactive",
        "expiresAt": "2024-11-21T08:43:41.194Z"
      }
    ]
  },
  "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

useraccessKey

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

application/json

AddItemToFeed (object)

Response

201404422

Created

Body

application/json

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

Conversation (object)nullable object

conferenceany of

nullable objectnullable object

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

JavaScriptCurlPython

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

201404422

{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "agent": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "team": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "type": "conversation",
  "archived": false,
  "closed": false,
  "private": false,
  "deleted": false,
  "spam": false,
  "seen": false,
  "seenBy": "123e4567-e89b-12d3-a456-426614174000",
  "replySuggestion": "text",
  "createdAt": "2024-11-21T08:43:41.194Z",
  "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
  "lastActivityAt": "2024-11-21T08:43:41.194Z",
  "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "status": "draft",
      "addedAt": "2024-11-21T08:43:41.194Z",
      "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",
      "itemSubject": "text",
      "createdAt": "2024-11-21T08:43:41.194Z"
    }
  ],
  "mergeInfo": {
    "mergedFrom": [
      {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2024-11-21T08:43:41.194Z"
      }
    ],
    "mergedInto": {
      "userId": "text",
      "itemId": "text",
      "createdAt": "2024-11-21T08:43:41.194Z"
    }
  },
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2024-11-21T08:43:41.194Z",
            "selected": false
          }
        ],
        "valueText": "text",
        "valueNumber": 0,
        "valueBoolean": false,
        "valueDate": "2024-11-21"
      }
    ]
  },
  "summaryForm": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2024-11-21T08:43:41.194Z",
            "selected": false
          }
        ],
        "valueText": "text",
        "valueNumber": 0,
        "valueBoolean": false,
        "valueDate": "2024-11-21"
      }
    ]
  },
  "queueInfo": {
    "queueId": "123e4567-e89b-12d3-a456-426614174000",
    "queueName": "text",
    "queuedAt": "2024-11-21T08:43:41.194Z"
  },
  "conversation": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "active",
    "visibility": "public",
    "accessibility": "open",
    "featuredParticipants": [
      {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      }
    ],
    "initiatingParticipant": {
      "id": "text",
      "displayName": "text",
      "avatarUrl": "text",
      "contact": {
        "identifierKey": "text",
        "identifierValue": "text",
        "platformAddress": "text",
        "platformAddressSelector": "text"
      },
      "type": "user",
      "status": "pending"
    },
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "lastMessage": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "preview": {
        "text": "text"
      },
      "status": "accepted",
      "sender": {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      },
      "recipients": [
        {
          "id": "text",
          "type": "to",
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text",
          "contactAnnotation": {
            "name": "text"
          }
        }
      ],
      "createdAt": "2024-11-21T08:43:41.194Z"
    },
    "createdAt": "2024-11-21T08:43:41.194Z",
    "updatedAt": "2024-11-21T08:43:41.194Z",
    "platformStyle": "direct",
    "referral": {
      "sourceUrl": "text",
      "sourceId": "text",
      "sourceType": "text",
      "mediaUrl": "text",
      "mediaType": "text",
      "caption": "text",
      "title": "text",
      "text": "text",
      "username": "text",
      "timestamp": "2024-11-21T08:43:41.194Z"
    }
  },
  "slaPolicy": {
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "timers": [
      {
        "metric": "firstReplyTime",
        "severity": "breach",
        "status": "inactive",
        "expiresAt": "2024-11-21T08:43:41.194Z"
      }
    ]
  },
  "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

useraccessKey

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

204404422

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404422

{
  "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

useraccessKey

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

application/json

mergeFrom*MergeItem (object)

mergeInto*MergeItem (object)

Response

200404422

Ok

Body

application/json

mergedFrom*Item (object)

mergedInto*Item (object)

mergedFromMessageSentIdstring (uuid)

mergedIntoMessageSentIdstring (uuid)

mergedFromCommentCreatedIdstring (uuid)

mergedIntoCommentCreatedIdstring (uuid)

Request

JavaScriptCurlPython

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

200404422

{
  "mergedFrom": {
    "id": "text",
    "feedId": "text",
    "feedIndexId": "text",
    "feedIndexType": "text",
    "agent": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "team": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "type": "conversation",
    "archived": false,
    "closed": false,
    "private": false,
    "deleted": false,
    "spam": false,
    "seen": false,
    "seenBy": "123e4567-e89b-12d3-a456-426614174000",
    "replySuggestion": "text",
    "createdAt": "2024-11-21T08:43:41.194Z",
    "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
    "lastActivityAt": "2024-11-21T08:43:41.194Z",
    "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "status": "draft",
        "addedAt": "2024-11-21T08:43:41.194Z",
        "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",
        "itemSubject": "text",
        "createdAt": "2024-11-21T08:43:41.194Z"
      }
    ],
    "mergeInfo": {
      "mergedFrom": [
        {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      ],
      "mergedInto": {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2024-11-21T08:43:41.194Z"
      }
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2024-11-21T08:43:41.194Z",
              "selected": false
            }
          ],
          "valueText": "text",
          "valueNumber": 0,
          "valueBoolean": false,
          "valueDate": "2024-11-21"
        }
      ]
    },
    "summaryForm": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2024-11-21T08:43:41.194Z",
              "selected": false
            }
          ],
          "valueText": "text",
          "valueNumber": 0,
          "valueBoolean": false,
          "valueDate": "2024-11-21"
        }
      ]
    },
    "queueInfo": {
      "queueId": "123e4567-e89b-12d3-a456-426614174000",
      "queueName": "text",
      "queuedAt": "2024-11-21T08:43:41.194Z"
    },
    "conversation": {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "active",
      "visibility": "public",
      "accessibility": "open",
      "featuredParticipants": [
        {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        }
      ],
      "initiatingParticipant": {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      },
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "lastMessage": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "preview": {
          "text": "text"
        },
        "status": "accepted",
        "sender": {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        },
        "recipients": [
          {
            "id": "text",
            "type": "to",
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text",
            "contactAnnotation": {
              "name": "text"
            }
          }
        ],
        "createdAt": "2024-11-21T08:43:41.194Z"
      },
      "createdAt": "2024-11-21T08:43:41.194Z",
      "updatedAt": "2024-11-21T08:43:41.194Z",
      "platformStyle": "direct",
      "referral": {
        "sourceUrl": "text",
        "sourceId": "text",
        "sourceType": "text",
        "mediaUrl": "text",
        "mediaType": "text",
        "caption": "text",
        "title": "text",
        "text": "text",
        "username": "text",
        "timestamp": "2024-11-21T08:43:41.194Z"
      }
    },
    "slaPolicy": {
      "policyId": "123e4567-e89b-12d3-a456-426614174000",
      "timers": [
        {
          "metric": "firstReplyTime",
          "severity": "breach",
          "status": "inactive",
          "expiresAt": "2024-11-21T08:43:41.194Z"
        }
      ]
    },
    "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"
    },
    "type": "conversation",
    "archived": false,
    "closed": false,
    "private": false,
    "deleted": false,
    "spam": false,
    "seen": false,
    "seenBy": "123e4567-e89b-12d3-a456-426614174000",
    "replySuggestion": "text",
    "createdAt": "2024-11-21T08:43:41.194Z",
    "willBeDeletedAt": "2024-11-21T08:43:41.194Z",
    "lastActivityAt": "2024-11-21T08:43:41.194Z",
    "lastMessageByContactAt": "2024-11-21T08:43:41.194Z",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "status": "draft",
        "addedAt": "2024-11-21T08:43:41.194Z",
        "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",
        "itemSubject": "text",
        "createdAt": "2024-11-21T08:43:41.194Z"
      }
    ],
    "mergeInfo": {
      "mergedFrom": [
        {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2024-11-21T08:43:41.194Z"
        }
      ],
      "mergedInto": {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2024-11-21T08:43:41.194Z"
      }
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2024-11-21T08:43:41.194Z",
              "selected": false
            }
          ],
          "valueText": "text",
          "valueNumber": 0,
          "valueBoolean": false,
          "valueDate": "2024-11-21"
        }
      ]
    },
    "summaryForm": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2024-11-21T08:43:41.194Z",
              "selected": false
            }
          ],
          "valueText": "text",
          "valueNumber": 0,
          "valueBoolean": false,
          "valueDate": "2024-11-21"
        }
      ]
    },
    "queueInfo": {
      "queueId": "123e4567-e89b-12d3-a456-426614174000",
      "queueName": "text",
      "queuedAt": "2024-11-21T08:43:41.194Z"
    },
    "conversation": {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "active",
      "visibility": "public",
      "accessibility": "open",
      "featuredParticipants": [
        {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        }
      ],
      "initiatingParticipant": {
        "id": "text",
        "displayName": "text",
        "avatarUrl": "text",
        "contact": {
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text"
        },
        "type": "user",
        "status": "pending"
      },
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "lastMessage": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "preview": {
          "text": "text"
        },
        "status": "accepted",
        "sender": {
          "id": "text",
          "displayName": "text",
          "avatarUrl": "text",
          "contact": {
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text"
          },
          "type": "user",
          "status": "pending"
        },
        "recipients": [
          {
            "id": "text",
            "type": "to",
            "identifierKey": "text",
            "identifierValue": "text",
            "platformAddress": "text",
            "platformAddressSelector": "text",
            "contactAnnotation": {
              "name": "text"
            }
          }
        ],
        "createdAt": "2024-11-21T08:43:41.194Z"
      },
      "createdAt": "2024-11-21T08:43:41.194Z",
      "updatedAt": "2024-11-21T08:43:41.194Z",
      "platformStyle": "direct",
      "referral": {
        "sourceUrl": "text",
        "sourceId": "text",
        "sourceType": "text",
        "mediaUrl": "text",
        "mediaType": "text",
        "caption": "text",
        "title": "text",
        "text": "text",
        "username": "text",
        "timestamp": "2024-11-21T08:43:41.194Z"
      }
    },
    "slaPolicy": {
      "policyId": "123e4567-e89b-12d3-a456-426614174000",
      "timers": [
        {
          "metric": "firstReplyTime",
          "severity": "breach",
          "status": "inactive",
          "expiresAt": "2024-11-21T08:43:41.194Z"
        }
      ]
    },
    "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"
}