Feeds | Bird API Docs

No-code docs

Create feed

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

post

/workspaces/{workspaceId}/feeds

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestringrequired

emojistring

queryobject

itemListOptionsobject | nullable

indexTypestring · enumrequired

Options: custom, view, privateview

accessEntitiesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/feeds' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","query":{"countOnly":false,"dynamicFields":{"fields":[{"selectedValueIds":[null]}]},"slaPolicyStatus":"ok","slaMetric":"firstReplyTime","query":{"operator":"and","children":[{"operator":"and","children":"[Circular Reference]"}]},"sort":"createdAt","indexType":"channel","itemType":"conversation","replyStatus":"noFollowUp","slaStatus":"active","conversationIds":[null],"itemIds":[null],"ticketNumbers":[null],"teamIds":[null],"tagIds":[null],"conversationChannelIds":[null],"conversationParticipantTypes":["user"],"conversationExcludeParticipantTypes":["user"],"conversationLastMessageSenderParticipantTypes":["user"],"itemTypes":["conversation"],"conversationStatuses":["active"],"conferenceStatuses":["accepted"],"itemStatuses":["open"],"agentIds":[],"conversationFeaturedParticipantIds":[],"participants":{"contacts":[null],"agents":[]},"fromContact":{"id":"123e4567-e89b-12d3-a456-426614174000"}},"itemListOptions":{"reverse":true,"sort":"createdAt","columns":["contact"]},"indexType":"custom","accessEntities":[{"entityId":"123e4567-e89b-12d3-a456-426614174000","entityType":"inbox-team"}]}'

201

404

422

{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "countOnly": false,
    "indexId": "text",
    "unassigned": true,
    "closed": true,
    "archived": true,
    "seen": true,
    "conversationName": "text",
    "dynamicFields": {
      "fields": [
        {
          "selectedValueIds": [
            null
          ]
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "dateFrom": "2025-02-21T18:14:30.070Z",
    "dateTo": "2025-02-21T18:14:30.070Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "slaExpiresBefore": "2025-02-21T18:14:30.070Z",
    "slaExpiresAfter": "2025-02-21T18:14:30.070Z",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true,
    "sort": "createdAt",
    "indexType": "channel",
    "itemType": "conversation",
    "replyStatus": "noFollowUp",
    "slaStatus": "active",
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "itemTypes": [
      "conversation"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "itemStatuses": [
      "open"
    ],
    "agentIds": [],
    "conversationFeaturedParticipantIds": [],
    "participants": {
      "contacts": [
        null
      ],
      "agents": []
    },
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "itemListOptions": {
    "reverse": true,
    "sort": "createdAt",
    "columns": [
      "contact"
    ]
  },
  "itemCount": 1,
  "unseenCount": 1,
  "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

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

indexTypestring · enum

The type of feed.

Options: channel, participant, team, agent, custom, view, privateview, task

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/feeds' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "indexType": "text",
      "indexId": "text",
      "name": "text",
      "emoji": "text",
      "query": {
        "countOnly": false,
        "indexId": "text",
        "unassigned": true,
        "closed": true,
        "archived": true,
        "seen": true,
        "conversationName": "text",
        "dynamicFields": {
          "fields": [
            {
              "selectedValueIds": [
                null
              ]
            }
          ]
        },
        "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
        "dateFrom": "2025-02-21T18:14:30.070Z",
        "dateTo": "2025-02-21T18:14:30.070Z",
        "searchTerm": "text",
        "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
        "hasSlaPolicy": true,
        "slaPolicyStatus": "ok",
        "slaMetric": "firstReplyTime",
        "slaExpiresBefore": "2025-02-21T18:14:30.070Z",
        "slaExpiresAfter": "2025-02-21T18:14:30.070Z",
        "query": {
          "operator": "and",
          "children": [
            {
              "operator": "and",
              "children": "[Circular Reference]"
            }
          ]
        },
        "spam": true,
        "sort": "createdAt",
        "indexType": "channel",
        "itemType": "conversation",
        "replyStatus": "noFollowUp",
        "slaStatus": "active",
        "conversationIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "itemIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "ticketNumbers": [
          1
        ],
        "teamIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "tagIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "conversationChannelIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "conversationParticipantTypes": [
          "user"
        ],
        "conversationExcludeParticipantTypes": [
          "user"
        ],
        "conversationLastMessageSenderParticipantTypes": [
          "user"
        ],
        "itemTypes": [
          "conversation"
        ],
        "conversationStatuses": [
          "active"
        ],
        "conferenceStatuses": [
          "accepted"
        ],
        "itemStatuses": [
          "open"
        ],
        "agentIds": [],
        "conversationFeaturedParticipantIds": [],
        "participants": {
          "contacts": [
            null
          ],
          "agents": []
        },
        "fromContact": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "itemListOptions": {
        "reverse": true,
        "sort": "createdAt",
        "columns": [
          "contact"
        ]
      },
      "itemCount": 1,
      "unseenCount": 1,
      "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

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

countOnlyboolean

Return only the count of the results, not the results themselves

Body

countOnlyboolean

Return only the count of the results, not the results themselves

indexIdstring

unassignedbooleanDeprecated

Search for feed items that have no agent assigned.

closedboolean

archivedboolean

seenboolean

conversationNamestring

dynamicFieldsobject | nullable

conferenceIdstring · uuid

dateFromstring · date-time

dateTostring · date-time

searchTermstring

slaPolicyIdstring · uuid

hasSlaPolicyboolean

slaPolicyStatusstring · 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.

Options: ok, needsAttention, breached

slaMetricstring · enum

Options: firstReplyTime, nextReplyTime

slaExpiresBeforestring · date-timeDeprecated

slaExpiresAfterstring · date-timeDeprecated

queryany of

spamboolean

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

sortstring · enum · default: createdAt

Options: createdAt, lastActivity, lastMessageByContact, slaExpires

indexTypestring · enum

Options: channel, participant, team, agent, custom, task

itemTypestring · enum

Options: conversation, conference, task

replyStatusstring · enum

Options: noFollowUp, noCustomerReply, noAgentReply

slaStatusstring · enumDeprecated

Options: active, expired

conversationIdsstring · uuid[]

itemIdsstring · uuid[]

ticketNumbersnumber[]

teamIdsstring · uuid[]

tagIdsstring · uuid[]

conversationChannelIdsstring · uuid[]

conversationParticipantTypesstring · enum[]

conversationExcludeParticipantTypesstring · enum[]

conversationLastMessageSenderParticipantTypesstring · enum[]

itemTypesstring · enum[]

conversationStatusesstring · enum[]

conferenceStatusesstring · enum[]

itemStatusesstring · enum[]

agentIdsone of[]

conversationFeaturedParticipantIdsone of[]Deprecated

participantsobject

fromContactone of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/search/feed-items' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"countOnly":false,"dynamicFields":{"fields":[{"selectedValueIds":[null]}]},"slaPolicyStatus":"ok","slaMetric":"firstReplyTime","query":{"operator":"and","children":[{"operator":"and","children":"[Circular Reference]"}]},"sort":"createdAt","indexType":"channel","itemType":"conversation","replyStatus":"noFollowUp","slaStatus":"active","conversationIds":[null],"itemIds":[null],"ticketNumbers":[null],"teamIds":[null],"tagIds":[null],"conversationChannelIds":[null],"conversationParticipantTypes":["user"],"conversationExcludeParticipantTypes":["user"],"conversationLastMessageSenderParticipantTypes":["user"],"itemTypes":["conversation"],"conversationStatuses":["active"],"conferenceStatuses":["accepted"],"itemStatuses":["open"],"agentIds":[],"conversationFeaturedParticipantIds":[],"participants":{"contacts":[null],"agents":[]},"fromContact":{"id":"123e4567-e89b-12d3-a456-426614174000"}}'

200

404

422

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "number": 1,
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-02-21T18:14:30.070Z",
      "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
      "lastActivityAt": "2025-02-21T18:14:30.070Z",
      "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-02-21T18:14:30.070Z"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "status": "text",
      "statusCategory": "new",
      "type": "conversation",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "addedAt": "2025-02-21T18:14:30.070Z",
          "status": "draft",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        }
      ],
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "mergeInfo": {
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        },
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "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": "active"
        },
        "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": "active"
          },
          "createdAt": "2024-01-01T00:00:00.123Z",
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "identifierKey": "emailaddress",
              "identifierValue": "example@bird.com",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "type": "to",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ]
        },
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "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": true,
        "likelySpamReason": "advertisement",
        "resource": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "task"
        },
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "platformStyle": "direct",
        "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": "active"
          }
        ],
        "attributes": {
          "myCustomField": "abc"
        }
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "nextPageToken": "text"
}

Search feed items

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

get

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

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

countOnlyboolean

Return only the count of the results, not the results themselves

sortstring · enum · default: createdAt

The results can optionally be sorted by one of these fields.

Options: createdAt, lastActivity, lastMessageByContact, slaExpires

indexTypestring · enum

The type of feed.

Options: channel, participant, team, agent, custom, view, privateview, task

indexIdstring

The id for indexType.

itemIdsstring · uuid[]

Filter by specific root item IDs (conversation IDs or conference IDs, or a combination of both).

itemTypestring · enum

The feed item type.

Options: conversation, conference, task

itemTypesstring · enum[]

The feed item type.

ticketNumbersnumber[]

Filter by specific ticket number.

unassignedboolean

Search for feed items that have no agent assigned.

agentIdsstring · uuid[]

The id of the agent(s) assigned to this item.

teamIdsstring · uuid[]

The id of the team(s) assigned to this item.

closedboolean

Whether to include closed feed items or not. All items are included by default

seenboolean

Whether to include seen feed items or not. All items are included by default

archivedboolean

Whether to include archived feed items or not. All items are included by default

tagIdsstring[]

Search for feed items containing these tags.

conversationIdsstring · uuid[]

Filter items for a specific conversation(s).

conversationNamestring

Filter items for a specific conversation name containing the term.

conversationChannelIdsstring · uuid[]

Filter items for a specific conversation channel(s).

conversationStatusesstring · enum[]

Filter items with a specific conversation status(es).

conferenceStatusesstring · enum[]

Filter items with a specific conference status(es).

conversationFeaturedParticipantIdsstring · uuid[]

Participant IDs for conversation feed items.

conversationParticipantTypesstring · enum[]

The types of participants in a conversation. It can be used for example to find out if there was any agent interaction in the conversation. This filter additionally filters out non-conversation feed items.

conversationExcludeParticipantTypesstring · enum[]

If specified, matched conversations will not contain participants of these types. It can be used for example to find out if there was NO agent interaction in the conversation.

conversationLastMessageSenderParticipantTypesstring · enum

The participant type that sent the last message in this feed item. It can match any of the specified types. This filter additionally filters out non-conversation feed items.

Options: user, contact, agent, flow, channel, connector

conferenceIdstring · uuid

itemStatusesstring · enum[]

Filter items with a specific status(es).

dateFromstring · date-time

Find messages created after this date.

dateTostring · date-time

Find messages created before this date.

searchTermstring

If specified, matched conversations will contain one of the search terms in one of its fields. searchTerm will be split into individual terms, and filter items accordingly. This can be used, for example, to find items with specific conversationName and ticketNumbers. If specified between quotes, matched conversations will contain the whole phrase on conversationName or in the conversation body.

slaPolicyIdstring · uuid

Find messages with the SLA policy attached.

hasSlaPolicyboolean

Find messages that have a SLA policy attached.

slaPolicyStatusstring · 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.

Options: ok, needsAttention, breached

slaMetricstring · enum

Find messages with an active SLA timer for this metric.

Options: firstReplyTime, nextReplyTime

slaStatusstring · enumDeprecated

Find message with a SLA timer with this status.

Options: active, expired

slaExpiresBeforestring · date-timeDeprecated

Find message where the next SLA breach is before this date.

slaExpiresAfterstring · date-timeDeprecated

Find message where the next SLA breach is after this date.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/search/feed-items' \
  --header 'Authorization: Bearer jwt'

200

404

422

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "number": 1,
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-02-21T18:14:30.070Z",
      "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
      "lastActivityAt": "2025-02-21T18:14:30.070Z",
      "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-02-21T18:14:30.070Z"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "status": "text",
      "statusCategory": "new",
      "type": "conversation",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "addedAt": "2025-02-21T18:14:30.070Z",
          "status": "draft",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        }
      ],
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "mergeInfo": {
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        },
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "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": "active"
        },
        "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": "active"
          },
          "createdAt": "2024-01-01T00:00:00.123Z",
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "identifierKey": "emailaddress",
              "identifierValue": "example@bird.com",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "type": "to",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ]
        },
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "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": true,
        "likelySpamReason": "advertisement",
        "resource": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "task"
        },
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "platformStyle": "direct",
        "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": "active"
          }
        ],
        "attributes": {
          "myCustomField": "abc"
        }
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "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}

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Represents an identifier for feed or feed contents. Supported formats '<indexType>:<feedId>' or '<indexType>:<idPrefix>:<feedId>', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/feeds/{feedId}' \
  --header 'Authorization: Bearer jwt'

200

403

404

{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "countOnly": false,
    "indexId": "text",
    "unassigned": true,
    "closed": true,
    "archived": true,
    "seen": true,
    "conversationName": "text",
    "dynamicFields": {
      "fields": [
        {
          "selectedValueIds": [
            null
          ]
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "dateFrom": "2025-02-21T18:14:30.070Z",
    "dateTo": "2025-02-21T18:14:30.070Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "slaExpiresBefore": "2025-02-21T18:14:30.070Z",
    "slaExpiresAfter": "2025-02-21T18:14:30.070Z",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true,
    "sort": "createdAt",
    "indexType": "channel",
    "itemType": "conversation",
    "replyStatus": "noFollowUp",
    "slaStatus": "active",
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "itemTypes": [
      "conversation"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "itemStatuses": [
      "open"
    ],
    "agentIds": [],
    "conversationFeaturedParticipantIds": [],
    "participants": {
      "contacts": [
        null
      ],
      "agents": []
    },
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "itemListOptions": {
    "reverse": true,
    "sort": "createdAt",
    "columns": [
      "contact"
    ]
  },
  "itemCount": 1,
  "unseenCount": 1,
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ]
}

Updates Feed

Perform an update on a given feed.

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Body

namestring

emojistring

queryobject

itemListOptionsobject | nullable

accessEntitiesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/feeds/{feedId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"countOnly":false,"dynamicFields":{"fields":[{"selectedValueIds":[null]}]},"slaPolicyStatus":"ok","slaMetric":"firstReplyTime","query":{"operator":"and","children":[{"operator":"and","children":"[Circular Reference]"}]},"sort":"createdAt","indexType":"channel","itemType":"conversation","replyStatus":"noFollowUp","slaStatus":"active","conversationIds":[null],"itemIds":[null],"ticketNumbers":[null],"teamIds":[null],"tagIds":[null],"conversationChannelIds":[null],"conversationParticipantTypes":["user"],"conversationExcludeParticipantTypes":["user"],"conversationLastMessageSenderParticipantTypes":["user"],"itemTypes":["conversation"],"conversationStatuses":["active"],"conferenceStatuses":["accepted"],"itemStatuses":["open"],"agentIds":[],"conversationFeaturedParticipantIds":[],"participants":{"contacts":[null],"agents":[]},"fromContact":{"id":"123e4567-e89b-12d3-a456-426614174000"}},"itemListOptions":{"reverse":true,"sort":"createdAt","columns":["contact"]},"accessEntities":[{"entityId":"123e4567-e89b-12d3-a456-426614174000","entityType":"inbox-team"}]}'

200

403

404

422

{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "countOnly": false,
    "indexId": "text",
    "unassigned": true,
    "closed": true,
    "archived": true,
    "seen": true,
    "conversationName": "text",
    "dynamicFields": {
      "fields": [
        {
          "selectedValueIds": [
            null
          ]
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "dateFrom": "2025-02-21T18:14:30.070Z",
    "dateTo": "2025-02-21T18:14:30.070Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "slaExpiresBefore": "2025-02-21T18:14:30.070Z",
    "slaExpiresAfter": "2025-02-21T18:14:30.070Z",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true,
    "sort": "createdAt",
    "indexType": "channel",
    "itemType": "conversation",
    "replyStatus": "noFollowUp",
    "slaStatus": "active",
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "itemTypes": [
      "conversation"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "itemStatuses": [
      "open"
    ],
    "agentIds": [],
    "conversationFeaturedParticipantIds": [],
    "participants": {
      "contacts": [
        null
      ],
      "agents": []
    },
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "itemListOptions": {
    "reverse": true,
    "sort": "createdAt",
    "columns": [
      "contact"
    ]
  },
  "itemCount": 1,
  "unseenCount": 1,
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ]
}

Delete Feed

Permanently delete a feed.

delete

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

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/feeds/{feedId}' \
  --header 'Authorization: Bearer jwt'

204

403

404

422

No body

Deleted

List items for a channel, participant or team feed

Obtain a list of items within the feed.

get

/workspaces/{workspaceId}/feeds/{feedId}/items

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

sortBystring · enum

Sort applied to the list

Options: lastActivity, lastMessageByContact, createdAt, slaExpires

ticketNumbersnumber[]

Filter by specific ticket number.

unassignedboolean

Search for feed items that have no agent assigned.

agentIdsstring · uuid[]

The id of the agent(s) assigned to this item.

teamIdsstring · uuid[]

The id of the team(s) assigned to this item.

closedboolean

Whether to include closed feed items or not. All items are included by default

seenboolean

Whether to include seen feed items or not. All items are included by default

archivedboolean

Whether to include archived feed items or not. All items are included by default

tagIdsstring[]

Search for feed items containing these tags.

conversationIdsstring · uuid[]

Filter items for a specific conversation(s).

conversationChannelIdsstring · uuid[]

Filter items for a specific conversation channel(s).

conversationNamestring

Filter items for a specific conversation name containing the term.

conversationStatusesstring · enum[]

Filter items with a specific conversation status(es).

conferenceStatusesstring · enum[]

Filter items with a specific conference status(es).

conversationFeaturedParticipantIdsstring · uuid[]

Participant IDs for conversation feed items.

conversationParticipantTypesstring · enum[]

conversationExcludeParticipantTypesstring · enum[]

If specified, matched conversations will not contain participants of these types. It can be used for example to find out if there was NO agent interaction in the conversation.

conversationLastMessageSenderParticipantTypesstring · enum

The participant type that sent the last message in this feed item. It can match any of the specified types. This filter additionally filters out non-conversation feed items.

Options: user, contact, agent, flow, channel, connector

itemStatusesstring · enum[]

Filter items with a specific status(es).

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items' \
  --header 'Authorization: Bearer jwt'

200

403

404

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "number": 1,
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-02-21T18:14:30.070Z",
      "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
      "lastActivityAt": "2025-02-21T18:14:30.070Z",
      "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-02-21T18:14:30.070Z"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "status": "text",
      "statusCategory": "new",
      "type": "conversation",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "addedAt": "2025-02-21T18:14:30.070Z",
          "status": "draft",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        }
      ],
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "mergeInfo": {
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        },
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "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": "active"
        },
        "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": "active"
          },
          "createdAt": "2024-01-01T00:00:00.123Z",
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "identifierKey": "emailaddress",
              "identifierValue": "example@bird.com",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "type": "to",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ]
        },
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "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": true,
        "likelySpamReason": "advertisement",
        "resource": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "task"
        },
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "platformStyle": "direct",
        "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": "active"
          }
        ],
        "attributes": {
          "myCustomField": "abc"
        }
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "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

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Body

agentIdstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json'

202

403

404

422

No body

Accepted

Get individual feed for logged in agent

Retrieve the feed for currently logged in agent.

get

/workspaces/{workspaceId}/me/feeds/{alias}

Authorizations

Path parameters

workspaceIdstringrequired

aliasstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/me/feeds/{alias}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "countOnly": false,
    "indexId": "text",
    "unassigned": true,
    "closed": true,
    "archived": true,
    "seen": true,
    "conversationName": "text",
    "dynamicFields": {
      "fields": [
        {
          "selectedValueIds": [
            null
          ]
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "dateFrom": "2025-02-21T18:14:30.070Z",
    "dateTo": "2025-02-21T18:14:30.070Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "slaExpiresBefore": "2025-02-21T18:14:30.070Z",
    "slaExpiresAfter": "2025-02-21T18:14:30.070Z",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true,
    "sort": "createdAt",
    "indexType": "channel",
    "itemType": "conversation",
    "replyStatus": "noFollowUp",
    "slaStatus": "active",
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "itemTypes": [
      "conversation"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "itemStatuses": [
      "open"
    ],
    "agentIds": [],
    "conversationFeaturedParticipantIds": [],
    "participants": {
      "contacts": [
        null
      ],
      "agents": []
    },
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "itemListOptions": {
    "reverse": true,
    "sort": "createdAt",
    "columns": [
      "contact"
    ]
  },
  "itemCount": 1,
  "unseenCount": 1,
  "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

Authorizations

Path parameters

workspaceIdstringrequired

aliasstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/me/feeds/{alias}/items' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "feedId": "text",
      "feedIndexId": "text",
      "feedIndexType": "text",
      "agent": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "team": {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      },
      "number": 1,
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-02-21T18:14:30.070Z",
      "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
      "lastActivityAt": "2025-02-21T18:14:30.070Z",
      "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-02-21",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-02-21T18:14:30.070Z",
                "selected": true
              }
            ]
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-02-21T18:14:30.070Z"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "status": "text",
      "statusCategory": "new",
      "type": "conversation",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "addedAt": "2025-02-21T18:14:30.070Z",
          "status": "draft",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        }
      ],
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "mergeInfo": {
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        },
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-02-21T18:14:30.070Z"
          }
        ]
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "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": "active"
        },
        "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": "active"
          },
          "createdAt": "2024-01-01T00:00:00.123Z",
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "identifierKey": "emailaddress",
              "identifierValue": "example@bird.com",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "type": "to",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ]
        },
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "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": true,
        "likelySpamReason": "advertisement",
        "resource": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "task"
        },
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "platformStyle": "direct",
        "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": "active"
          }
        ],
        "attributes": {
          "myCustomField": "abc"
        }
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "nextPageToken": "text"
}

Get Feed Item By a specific filter

Retrieve information about a specific item.

get

/workspaces/{workspaceId}/feeds/items

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

ticketNumberinteger · min: 1required

Ticket number

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/feeds/items?ticketNumber=1' \
  --header 'Authorization: Bearer jwt'

200

404

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

Authorizations

Path parameters

workspaceIdstringrequired

itemIdstringrequired

Feed Item UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/feeds/items/{itemId}' \
  --header 'Authorization: Bearer jwt'

200

404

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

Authorizations

Path parameters

workspaceIdstringrequired

itemIdstringrequired

Feed Item UUID

feedIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  --header 'Authorization: Bearer jwt'

200

403

404

{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "agent": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "team": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "number": 1,
  "archived": true,
  "closed": true,
  "private": true,
  "deleted": true,
  "spam": true,
  "senderBlocked": true,
  "seen": true,
  "seenBy": "123e4567-e89b-12d3-a456-426614174000",
  "replySuggestion": "text",
  "createdAt": "2025-02-21T18:14:30.070Z",
  "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
  "lastActivityAt": "2025-02-21T18:14:30.070Z",
  "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
  "attributes": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "filters": [
    [
      {
        "key": "text",
        "value": "text"
      }
    ]
  ],
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-02-21",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-02-21T18:14:30.070Z",
            "selected": true
          }
        ]
      }
    ]
  },
  "summaryForm": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-02-21",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-02-21T18:14:30.070Z",
            "selected": true
          }
        ]
      }
    ]
  },
  "queueInfo": {
    "queueId": "123e4567-e89b-12d3-a456-426614174000",
    "queueName": "text",
    "queuedAt": "2025-02-21T18:14:30.070Z"
  },
  "task": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "slaPolicy": {
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "timers": [
      {
        "metric": "firstReplyTime",
        "severity": "breach",
        "status": "inactive",
        "expiresAt": "2025-02-21T18:14:30.070Z"
      }
    ]
  },
  "status": "text",
  "statusCategory": "new",
  "type": "conversation",
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "addedAt": "2025-02-21T18:14:30.070Z",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "emoji": "text"
      }
    }
  ],
  "linkedItems": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "relation": "linkedTo",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "itemNumber": 1,
      "itemSubject": "text",
      "createdAt": "2025-02-21T18:14:30.070Z"
    }
  ],
  "requiredSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "mergeInfo": {
    "mergedInto": {
      "userId": "text",
      "itemId": "text",
      "createdAt": "2025-02-21T18:14:30.070Z"
    },
    "mergedFrom": [
      {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-02-21T18:14:30.070Z"
      }
    ]
  },
  "conversation": {
    "id": "299227f5-1c61-4341-ad50-efed5c048998",
    "name": "Re: Your refund request",
    "description": "Refund request ticket",
    "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": "active"
    },
    "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": "active"
      },
      "createdAt": "2024-01-01T00:00:00.123Z",
      "recipients": [
        {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "identifierKey": "emailaddress",
          "identifierValue": "example@bird.com",
          "platformAddress": "text",
          "platformAddressSelector": "attributes.workEmail",
          "type": "to",
          "contactAnnotation": {
            "name": "John Doe"
          }
        }
      ]
    },
    "createdAt": "2024-01-01T00:00:00.123Z",
    "updatedAt": "2024-01-01T00:00:00.123Z",
    "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": true,
    "likelySpamReason": "advertisement",
    "resource": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "task"
    },
    "status": "active",
    "visibility": "public",
    "accessibility": "open",
    "platformStyle": "direct",
    "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": "active"
      }
    ],
    "attributes": {
      "myCustomField": "abc"
    }
  },
  "conference": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update Feed Item

Modify the content of a specific item within a feed.

patch

/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}

Authorizations

Path parameters

workspaceIdstringrequired

itemIdstringrequired

Feed Item UUID

feedIdstringrequired

Body

agentIdstring | nullable

teamIdstring | nullable

archivedboolean | nullable

spamboolean | nullable

blockSenderboolean | nullable

closedboolean | nullable

seenboolean

privateboolean | nullable

replySuggestionstring

customAttributesobject | nullable

dynamicFieldsobject | nullable

summaryFormobject | nullable

slaPolicyIdstring · uuid | nullable

statusstring

The slug of the status to set on the feed item.

requiredSkillsobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"customAttributes":{"ANY_ADDITIONAL_PROPERTY":"anything"},"dynamicFields":{"fields":[{"selectedValueIds":[null]}]},"summaryForm":{"fields":[{"selectedValueIds":[null]}]},"requiredSkills":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"text","valueType":"single","selectedValues":[{"id":"123e4567-e89b-12d3-a456-426614174000","value":"text","icon":"text"}]}]}'

200

403

404

409

422

{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "agent": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "team": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "number": 1,
  "archived": true,
  "closed": true,
  "private": true,
  "deleted": true,
  "spam": true,
  "senderBlocked": true,
  "seen": true,
  "seenBy": "123e4567-e89b-12d3-a456-426614174000",
  "replySuggestion": "text",
  "createdAt": "2025-02-21T18:14:30.070Z",
  "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
  "lastActivityAt": "2025-02-21T18:14:30.070Z",
  "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
  "attributes": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "filters": [
    [
      {
        "key": "text",
        "value": "text"
      }
    ]
  ],
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-02-21",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-02-21T18:14:30.070Z",
            "selected": true
          }
        ]
      }
    ]
  },
  "summaryForm": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-02-21",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-02-21T18:14:30.070Z",
            "selected": true
          }
        ]
      }
    ]
  },
  "queueInfo": {
    "queueId": "123e4567-e89b-12d3-a456-426614174000",
    "queueName": "text",
    "queuedAt": "2025-02-21T18:14:30.070Z"
  },
  "task": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "slaPolicy": {
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "timers": [
      {
        "metric": "firstReplyTime",
        "severity": "breach",
        "status": "inactive",
        "expiresAt": "2025-02-21T18:14:30.070Z"
      }
    ]
  },
  "status": "text",
  "statusCategory": "new",
  "type": "conversation",
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "addedAt": "2025-02-21T18:14:30.070Z",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "emoji": "text"
      }
    }
  ],
  "linkedItems": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "relation": "linkedTo",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "itemNumber": 1,
      "itemSubject": "text",
      "createdAt": "2025-02-21T18:14:30.070Z"
    }
  ],
  "requiredSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "mergeInfo": {
    "mergedInto": {
      "userId": "text",
      "itemId": "text",
      "createdAt": "2025-02-21T18:14:30.070Z"
    },
    "mergedFrom": [
      {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-02-21T18:14:30.070Z"
      }
    ]
  },
  "conversation": {
    "id": "299227f5-1c61-4341-ad50-efed5c048998",
    "name": "Re: Your refund request",
    "description": "Refund request ticket",
    "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": "active"
    },
    "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": "active"
      },
      "createdAt": "2024-01-01T00:00:00.123Z",
      "recipients": [
        {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "identifierKey": "emailaddress",
          "identifierValue": "example@bird.com",
          "platformAddress": "text",
          "platformAddressSelector": "attributes.workEmail",
          "type": "to",
          "contactAnnotation": {
            "name": "John Doe"
          }
        }
      ]
    },
    "createdAt": "2024-01-01T00:00:00.123Z",
    "updatedAt": "2024-01-01T00:00:00.123Z",
    "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": true,
    "likelySpamReason": "advertisement",
    "resource": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "task"
    },
    "status": "active",
    "visibility": "public",
    "accessibility": "open",
    "platformStyle": "direct",
    "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": "active"
      }
    ],
    "attributes": {
      "myCustomField": "abc"
    }
  },
  "conference": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Updated

Add item to a feed

Add an existent item to an existent feed.

post

/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}

Authorizations

Path parameters

workspaceIdstringrequired

itemIdstringrequired

Feed Item UUID

feedIdstringrequired

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json'

201

404

422

{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "agent": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "team": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "number": 1,
  "archived": true,
  "closed": true,
  "private": true,
  "deleted": true,
  "spam": true,
  "senderBlocked": true,
  "seen": true,
  "seenBy": "123e4567-e89b-12d3-a456-426614174000",
  "replySuggestion": "text",
  "createdAt": "2025-02-21T18:14:30.070Z",
  "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
  "lastActivityAt": "2025-02-21T18:14:30.070Z",
  "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
  "attributes": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "filters": [
    [
      {
        "key": "text",
        "value": "text"
      }
    ]
  ],
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-02-21",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-02-21T18:14:30.070Z",
            "selected": true
          }
        ]
      }
    ]
  },
  "summaryForm": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-02-21",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-02-21T18:14:30.070Z",
            "selected": true
          }
        ]
      }
    ]
  },
  "queueInfo": {
    "queueId": "123e4567-e89b-12d3-a456-426614174000",
    "queueName": "text",
    "queuedAt": "2025-02-21T18:14:30.070Z"
  },
  "task": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "slaPolicy": {
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "timers": [
      {
        "metric": "firstReplyTime",
        "severity": "breach",
        "status": "inactive",
        "expiresAt": "2025-02-21T18:14:30.070Z"
      }
    ]
  },
  "status": "text",
  "statusCategory": "new",
  "type": "conversation",
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "addedAt": "2025-02-21T18:14:30.070Z",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "emoji": "text"
      }
    }
  ],
  "linkedItems": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "relation": "linkedTo",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "itemNumber": 1,
      "itemSubject": "text",
      "createdAt": "2025-02-21T18:14:30.070Z"
    }
  ],
  "requiredSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "mergeInfo": {
    "mergedInto": {
      "userId": "text",
      "itemId": "text",
      "createdAt": "2025-02-21T18:14:30.070Z"
    },
    "mergedFrom": [
      {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-02-21T18:14:30.070Z"
      }
    ]
  },
  "conversation": {
    "id": "299227f5-1c61-4341-ad50-efed5c048998",
    "name": "Re: Your refund request",
    "description": "Refund request ticket",
    "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": "active"
    },
    "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": "active"
      },
      "createdAt": "2024-01-01T00:00:00.123Z",
      "recipients": [
        {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "identifierKey": "emailaddress",
          "identifierValue": "example@bird.com",
          "platformAddress": "text",
          "platformAddressSelector": "attributes.workEmail",
          "type": "to",
          "contactAnnotation": {
            "name": "John Doe"
          }
        }
      ]
    },
    "createdAt": "2024-01-01T00:00:00.123Z",
    "updatedAt": "2024-01-01T00:00:00.123Z",
    "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": true,
    "likelySpamReason": "advertisement",
    "resource": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "task"
    },
    "status": "active",
    "visibility": "public",
    "accessibility": "open",
    "platformStyle": "direct",
    "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": "active"
      }
    ],
    "attributes": {
      "myCustomField": "abc"
    }
  },
  "conference": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Created

Remove item from feed

Removes an item from a feed.

delete

/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}

Authorizations

Path parameters

workspaceIdstringrequired

itemIdstringrequired

Feed Item UUID

feedIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  --header 'Authorization: Bearer jwt'

204

404

422

No body

Deleted

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

Authorizations

Path parameters

workspaceIdstringrequired

feedIdstringrequired

Body

mergeFromobjectrequired

mergeIntoobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/feeds/{feedId}/merge-items' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"mergeFrom":{"itemId":"123e4567-e89b-12d3-a456-426614174000","message":{"participantId":"text","participantType":"user","recipients":[{"type":"to"}],"body":{"type":"text","text":{"text":"text","actions":[{"type":"link","link":{"text":"text"}}],"attachments":[{"mediaUrl":"https://example.com","filename":"text"}],"metadata":{"telegram":{"parseMode":"Markdown"},"headers":{},"whatsapp":{},"line":{"emoji":{"items":[{"index":1,"productId":"text","emojiId":"text"}]}}}}}},"comment":{"body":{"type":"text","text":{"text":"text"}},"mentions":{"notify":{"onUpdate":false,"onDelete":false},"identifiers":[{}]},"replyTo":{"id":"123e4567-e89b-12d3-a456-426614174000","type":"comment"}}},"mergeInto":{"itemId":"123e4567-e89b-12d3-a456-426614174000","message":{"participantId":"text","participantType":"user","recipients":[{"type":"to"}],"body":{"type":"text","text":{"text":"text","actions":[{"type":"link","link":{"text":"text"}}],"attachments":[{"mediaUrl":"https://example.com","filename":"text"}],"metadata":{"telegram":{"parseMode":"Markdown"},"headers":{},"whatsapp":{},"line":{"emoji":{"items":[{"index":1,"productId":"text","emojiId":"text"}]}}}}}},"comment":{"body":{"type":"text","text":{"text":"text"}},"mentions":{"notify":{"onUpdate":false,"onDelete":false},"identifiers":[{}]},"replyTo":{"id":"123e4567-e89b-12d3-a456-426614174000","type":"comment"}}}}'

200

404

422

{
  "mergedFrom": {
    "id": "text",
    "feedId": "text",
    "feedIndexId": "text",
    "feedIndexType": "text",
    "agent": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "team": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "number": 1,
    "archived": true,
    "closed": true,
    "private": true,
    "deleted": true,
    "spam": true,
    "senderBlocked": true,
    "seen": true,
    "seenBy": "123e4567-e89b-12d3-a456-426614174000",
    "replySuggestion": "text",
    "createdAt": "2025-02-21T18:14:30.070Z",
    "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
    "lastActivityAt": "2025-02-21T18:14:30.070Z",
    "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
    "attributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "filters": [
      [
        {
          "key": "text",
          "value": "text"
        }
      ]
    ],
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-02-21",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-02-21T18:14:30.070Z",
              "selected": true
            }
          ]
        }
      ]
    },
    "summaryForm": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-02-21",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-02-21T18:14:30.070Z",
              "selected": true
            }
          ]
        }
      ]
    },
    "queueInfo": {
      "queueId": "123e4567-e89b-12d3-a456-426614174000",
      "queueName": "text",
      "queuedAt": "2025-02-21T18:14:30.070Z"
    },
    "task": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "slaPolicy": {
      "policyId": "123e4567-e89b-12d3-a456-426614174000",
      "timers": [
        {
          "metric": "firstReplyTime",
          "severity": "breach",
          "status": "inactive",
          "expiresAt": "2025-02-21T18:14:30.070Z"
        }
      ]
    },
    "status": "text",
    "statusCategory": "new",
    "type": "conversation",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "addedAt": "2025-02-21T18:14:30.070Z",
        "status": "draft",
        "category": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "emoji": "text"
        }
      }
    ],
    "linkedItems": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": "linkedTo",
        "itemId": "123e4567-e89b-12d3-a456-426614174000",
        "itemNumber": 1,
        "itemSubject": "text",
        "createdAt": "2025-02-21T18:14:30.070Z"
      }
    ],
    "requiredSkills": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "valueType": "single",
        "selectedValues": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "value": "text",
            "icon": "text"
          }
        ]
      }
    ],
    "mergeInfo": {
      "mergedInto": {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-02-21T18:14:30.070Z"
      },
      "mergedFrom": [
        {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        }
      ]
    },
    "conversation": {
      "id": "299227f5-1c61-4341-ad50-efed5c048998",
      "name": "Re: Your refund request",
      "description": "Refund request ticket",
      "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": "active"
      },
      "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": "active"
        },
        "createdAt": "2024-01-01T00:00:00.123Z",
        "recipients": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "identifierKey": "emailaddress",
            "identifierValue": "example@bird.com",
            "platformAddress": "text",
            "platformAddressSelector": "attributes.workEmail",
            "type": "to",
            "contactAnnotation": {
              "name": "John Doe"
            }
          }
        ]
      },
      "createdAt": "2024-01-01T00:00:00.123Z",
      "updatedAt": "2024-01-01T00:00:00.123Z",
      "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": true,
      "likelySpamReason": "advertisement",
      "resource": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "task"
      },
      "status": "active",
      "visibility": "public",
      "accessibility": "open",
      "platformStyle": "direct",
      "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": "active"
        }
      ],
      "attributes": {
        "myCustomField": "abc"
      }
    },
    "conference": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "mergedInto": {
    "id": "text",
    "feedId": "text",
    "feedIndexId": "text",
    "feedIndexType": "text",
    "agent": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "team": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "number": 1,
    "archived": true,
    "closed": true,
    "private": true,
    "deleted": true,
    "spam": true,
    "senderBlocked": true,
    "seen": true,
    "seenBy": "123e4567-e89b-12d3-a456-426614174000",
    "replySuggestion": "text",
    "createdAt": "2025-02-21T18:14:30.070Z",
    "willBeDeletedAt": "2025-02-21T18:14:30.070Z",
    "lastActivityAt": "2025-02-21T18:14:30.070Z",
    "lastMessageByContactAt": "2025-02-21T18:14:30.070Z",
    "attributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "filters": [
      [
        {
          "key": "text",
          "value": "text"
        }
      ]
    ],
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-02-21",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-02-21T18:14:30.070Z",
              "selected": true
            }
          ]
        }
      ]
    },
    "summaryForm": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-02-21",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-02-21T18:14:30.070Z",
              "selected": true
            }
          ]
        }
      ]
    },
    "queueInfo": {
      "queueId": "123e4567-e89b-12d3-a456-426614174000",
      "queueName": "text",
      "queuedAt": "2025-02-21T18:14:30.070Z"
    },
    "task": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "slaPolicy": {
      "policyId": "123e4567-e89b-12d3-a456-426614174000",
      "timers": [
        {
          "metric": "firstReplyTime",
          "severity": "breach",
          "status": "inactive",
          "expiresAt": "2025-02-21T18:14:30.070Z"
        }
      ]
    },
    "status": "text",
    "statusCategory": "new",
    "type": "conversation",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "addedAt": "2025-02-21T18:14:30.070Z",
        "status": "draft",
        "category": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "emoji": "text"
        }
      }
    ],
    "linkedItems": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": "linkedTo",
        "itemId": "123e4567-e89b-12d3-a456-426614174000",
        "itemNumber": 1,
        "itemSubject": "text",
        "createdAt": "2025-02-21T18:14:30.070Z"
      }
    ],
    "requiredSkills": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "valueType": "single",
        "selectedValues": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "value": "text",
            "icon": "text"
          }
        ]
      }
    ],
    "mergeInfo": {
      "mergedInto": {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-02-21T18:14:30.070Z"
      },
      "mergedFrom": [
        {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-02-21T18:14:30.070Z"
        }
      ]
    },
    "conversation": {
      "id": "299227f5-1c61-4341-ad50-efed5c048998",
      "name": "Re: Your refund request",
      "description": "Refund request ticket",
      "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": "active"
      },
      "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": "active"
        },
        "createdAt": "2024-01-01T00:00:00.123Z",
        "recipients": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "identifierKey": "emailaddress",
            "identifierValue": "example@bird.com",
            "platformAddress": "text",
            "platformAddressSelector": "attributes.workEmail",
            "type": "to",
            "contactAnnotation": {
              "name": "John Doe"
            }
          }
        ]
      },
      "createdAt": "2024-01-01T00:00:00.123Z",
      "updatedAt": "2024-01-01T00:00:00.123Z",
      "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": true,
      "likelySpamReason": "advertisement",
      "resource": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "task"
      },
      "status": "active",
      "visibility": "public",
      "accessibility": "open",
      "platformStyle": "direct",
      "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": "active"
        }
      ],
      "attributes": {
        "myCustomField": "abc"
      }
    },
    "conference": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "mergedFromMessageSentId": "123e4567-e89b-12d3-a456-426614174000",
  "mergedIntoMessageSentId": "123e4567-e89b-12d3-a456-426614174000",
  "mergedFromCommentCreatedId": "123e4567-e89b-12d3-a456-426614174000",
  "mergedIntoCommentCreatedId": "123e4567-e89b-12d3-a456-426614174000"
}