Feeds

Create feed

post

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

Authorizations
Path parameters
workspaceIdstringRequired
Body
indexTypestring · enumRequiredPossible values:
namestringRequired
emojistringOptional
Responses
201
OK
application/json
post
POST /workspaces/{workspaceId}/feeds HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 1834

{
  "indexType": "custom",
  "name": "text",
  "emoji": "text",
  "query": {
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "sort": "createdAt",
    "countOnly": false,
    "indexType": "channel",
    "indexId": "text",
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "itemType": "conversation",
    "itemTypes": [
      "conversation"
    ],
    "agentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "closed": true,
    "archived": true,
    "replyStatus": "noFollowUp",
    "seen": true,
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationName": "text",
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "participants": {
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "agents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "selectedValueIds": [
            "text"
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "valueDateBefore": "2025-07-03",
          "valueDateAfter": "2025-07-03"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2025-07-03T02:22:34.722Z",
    "dateTo": "2025-07-03T02:22:34.722Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true
  },
  "itemListOptions": {
    "sort": "createdAt",
    "reverse": true,
    "columns": [
      "contact"
    ]
  },
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ]
}
{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "sort": "createdAt",
    "countOnly": false,
    "indexType": "channel",
    "indexId": "text",
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "itemType": "conversation",
    "itemTypes": [
      "conversation"
    ],
    "agentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "closed": true,
    "archived": true,
    "replyStatus": "noFollowUp",
    "seen": true,
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationName": "text",
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "participants": {
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "agents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "selectedValueIds": [
            "text"
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "valueDateBefore": "2025-07-03",
          "valueDateAfter": "2025-07-03"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2025-07-03T02:22:34.722Z",
    "dateTo": "2025-07-03T02:22:34.722Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true
  },
  "itemListOptions": {
    "sort": "createdAt",
    "reverse": true,
    "columns": [
      "contact"
    ]
  },
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ],
  "itemCount": 1
}

List User Defined Feeds

get

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

Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10
pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false
indexTypestring · enumOptional

The type of feed.

Possible values:
Responses
200
ok
application/json
get
GET /workspaces/{workspaceId}/feeds HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "results": [
    {
      "id": "text",
      "indexType": "text",
      "indexId": "text",
      "name": "text",
      "emoji": "text",
      "query": {
        "conversationIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "sort": "createdAt",
        "countOnly": false,
        "indexType": "channel",
        "indexId": "text",
        "itemIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "ticketNumbers": [
          1
        ],
        "itemType": "conversation",
        "itemTypes": [
          "conversation"
        ],
        "agentIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "teamIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "closed": true,
        "archived": true,
        "replyStatus": "noFollowUp",
        "seen": true,
        "tagIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "conversationName": "text",
        "conversationChannelIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "conversationStatuses": [
          "active"
        ],
        "conferenceStatuses": [
          "accepted"
        ],
        "participants": {
          "contacts": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "agents": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "conversationParticipantTypes": [
          "user"
        ],
        "conversationExcludeParticipantTypes": [
          "user"
        ],
        "conversationLastMessageSenderParticipantTypes": [
          "user"
        ],
        "fromContact": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "dynamicFields": {
          "settingsId": "text",
          "fields": [
            {
              "id": "text",
              "selectedValueIds": [
                "text"
              ],
              "valueText": "text",
              "valueNumber": 1,
              "valueBoolean": true,
              "valueDate": "2025-07-03",
              "valueDateBefore": "2025-07-03",
              "valueDateAfter": "2025-07-03"
            }
          ]
        },
        "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
        "itemStatuses": [
          "open"
        ],
        "dateFrom": "2025-07-03T02:22:34.722Z",
        "dateTo": "2025-07-03T02:22:34.722Z",
        "searchTerm": "text",
        "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
        "hasSlaPolicy": true,
        "slaPolicyStatus": "ok",
        "slaMetric": "firstReplyTime",
        "query": {
          "operator": "and",
          "children": "[Circular Reference]"
        },
        "spam": true
      },
      "itemListOptions": {
        "sort": "createdAt",
        "reverse": true,
        "columns": [
          "contact"
        ]
      },
      "accessEntities": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "inbox-team"
        }
      ],
      "itemCount": 1
    }
  ]
}

Search feed items

post

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

Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10
pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false
countOnlybooleanOptional

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

Default: false
Body
conversationIdsstring · uuid[]Optional
sortstring · enumOptionalDefault: createdAtPossible values:
countOnlybooleanOptional

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

Default: false
indexTypestring · enumOptionalPossible values:
indexIdstringOptional
itemIdsstring · uuid[]Optional
ticketNumbersnumber[]Optional
itemTypestring · enumOptionalPossible values:
unassignedbooleanOptionalDeprecated

Search for feed items that have no agent assigned.

teamIdsstring · uuid[]Optional
closedbooleanOptional
archivedbooleanOptional
replyStatusstring · enumOptionalPossible values:
seenbooleanOptional
tagIdsstring · uuid[]Optional
conversationNamestringOptional
conversationChannelIdsstring · uuid[]Optional
fromContactone ofOptional
or
conferenceIdstring · uuidOptional
dateFromstring · date-timeOptional
dateTostring · date-timeOptional
searchTermstringOptional
slaPolicyIdstring · uuidOptional
hasSlaPolicybooleanOptional
slaPolicyStatusstring · enumOptional

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.
Possible values:
slaMetricstring · enumOptionalPossible values:
slaStatusstring · enumOptionalDeprecatedPossible values:
slaExpiresBeforestring · date-timeOptionalDeprecated
slaExpiresAfterstring · date-timeOptionalDeprecated
queryany ofOptional
or
or
or
or
or
or
spambooleanOptional

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

Responses
200
ok
application/json
Responseall of
post
POST /workspaces/{workspaceId}/search/feed-items HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 1603

{
  "conversationIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "sort": "createdAt",
  "countOnly": false,
  "indexType": "channel",
  "indexId": "text",
  "itemIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ticketNumbers": [
    1
  ],
  "itemType": "conversation",
  "itemTypes": [
    "conversation"
  ],
  "agentIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "teamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "closed": true,
  "archived": true,
  "replyStatus": "noFollowUp",
  "seen": true,
  "tagIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "conversationName": "text",
  "conversationChannelIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "conversationStatuses": [
    "active"
  ],
  "conferenceStatuses": [
    "accepted"
  ],
  "participants": {
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "agents": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  },
  "conversationParticipantTypes": [
    "user"
  ],
  "conversationExcludeParticipantTypes": [
    "user"
  ],
  "conversationLastMessageSenderParticipantTypes": [
    "user"
  ],
  "fromContact": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "selectedValueIds": [
          "text"
        ],
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-07-03",
        "valueDateBefore": "2025-07-03",
        "valueDateAfter": "2025-07-03"
      }
    ]
  },
  "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
  "itemStatuses": [
    "open"
  ],
  "dateFrom": "2025-07-03T02:22:34.722Z",
  "dateTo": "2025-07-03T02:22:34.722Z",
  "searchTerm": "text",
  "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
  "hasSlaPolicy": true,
  "slaPolicyStatus": "ok",
  "slaMetric": "firstReplyTime",
  "query": {
    "operator": "and",
    "children": [
      {
        "operator": "and",
        "children": [
          "[Circular Reference]"
        ]
      }
    ]
  },
  "spam": true
}
{
  "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,
      "type": "conversation",
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-07-03T02:22:34.722Z",
      "willBeDeletedAt": "2025-07-03T02:22:34.722Z",
      "lastActivityAt": "2025-07-03T02:22:34.722Z",
      "lastMessageByContactAt": "2025-07-03T02:22:34.722Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2025-07-03T02:22:34.722Z",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-07-03T02:22:34.722Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-07-03T02:22:34.722Z"
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "style": "default",
        "featuredParticipants": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "displayName": "John Doe",
            "avatarUrl": "https://example.bird.com/avatar-url",
            "contact": {
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          }
        ],
        "initiatingParticipant": {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "displayName": "John Doe",
          "avatarUrl": "https://example.bird.com/avatar-url",
          "contact": {
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "[email protected]",
            "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": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          },
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "type": "to",
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ],
          "draft": true,
          "createdAt": "2024-01-01T00:00:00.123Z"
        },
        "lastMessageIncomingAt": "2025-07-03T02:22:34.722Z",
        "lastMessageOutgoingAt": "2025-07-03T02:22:34.722Z",
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "platformStyle": "direct",
        "attributes": {
          "myCustomField": "abc"
        },
        "summary": "Re: Your refund request",
        "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": {
          "type": "task",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "hasDraft": true
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-07-03T02:22:34.722Z"
          }
        ]
      },
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "status": "text",
      "statusCategory": "new"
    }
  ],
  "total": 1,
  "nextPageToken": "text"
}

Search feed items

get

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

Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10
pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false
countOnlybooleanOptional

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

Default: false
sortstring · enumOptional

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

Default: createdAtPossible values:
indexTypestring · enumOptional

The type of feed.

Possible values:
indexIdstringOptional

The id for indexType.

itemIdsstring · uuid[]Optional

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

itemTypestring · enumOptional

The feed item type.

Possible values:
ticketNumbersnumber[]Optional

Filter by specific ticket number.

unassignedbooleanOptional

Search for feed items that have no agent assigned.

agentIdsstring · uuid[]Optional

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

teamIdsstring · uuid[]Optional

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

closedbooleanOptional

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

seenbooleanOptional

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

archivedbooleanOptional

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

tagIdsstring[]Optional

Search for feed items containing these tags.

conversationIdsstring · uuid[]Optional

Filter items for a specific conversation(s).

conversationNamestringOptional

Filter items for a specific conversation name containing the term.

conversationChannelIdsstring · uuid[]Optional

Filter items for a specific conversation channel(s).

conversationFeaturedParticipantIdsstring · uuid[]Optional

Participant IDs for conversation feed items.

conversationLastMessageSenderParticipantTypesstring · enumOptional

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.

Possible values:
conferenceIdstring · uuidOptional
dateFromstring · date-timeOptional

Find messages created after this date.

dateTostring · date-timeOptional

Find messages created before this date.

searchTermstringOptional

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 · uuidOptional

Find messages with the SLA policy attached.

hasSlaPolicybooleanOptional

Find messages that have a SLA policy attached.

slaPolicyStatusstring · enumOptional

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.
Possible values:
slaMetricstring · enumOptional

Find messages with an active SLA timer for this metric.

Possible values:
slaStatusstring · enumOptionalDeprecated

Find message with a SLA timer with this status.

Possible values:
slaExpiresBeforestring · date-timeOptionalDeprecated

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

slaExpiresAfterstring · date-timeOptionalDeprecated

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

Responses
200
ok
application/json
Responseall of
get
GET /workspaces/{workspaceId}/search/feed-items HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "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,
      "type": "conversation",
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-07-03T02:22:34.722Z",
      "willBeDeletedAt": "2025-07-03T02:22:34.722Z",
      "lastActivityAt": "2025-07-03T02:22:34.722Z",
      "lastMessageByContactAt": "2025-07-03T02:22:34.722Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2025-07-03T02:22:34.722Z",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-07-03T02:22:34.722Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-07-03T02:22:34.722Z"
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "style": "default",
        "featuredParticipants": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "displayName": "John Doe",
            "avatarUrl": "https://example.bird.com/avatar-url",
            "contact": {
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          }
        ],
        "initiatingParticipant": {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "displayName": "John Doe",
          "avatarUrl": "https://example.bird.com/avatar-url",
          "contact": {
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "[email protected]",
            "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": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          },
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "type": "to",
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ],
          "draft": true,
          "createdAt": "2024-01-01T00:00:00.123Z"
        },
        "lastMessageIncomingAt": "2025-07-03T02:22:34.722Z",
        "lastMessageOutgoingAt": "2025-07-03T02:22:34.722Z",
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "platformStyle": "direct",
        "attributes": {
          "myCustomField": "abc"
        },
        "summary": "Re: Your refund request",
        "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": {
          "type": "task",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "hasDraft": true
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-07-03T02:22:34.722Z"
          }
        ]
      },
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "status": "text",
      "statusCategory": "new"
    }
  ],
  "total": 1,
  "nextPageToken": "text"
}

Get feed for a channel, participant or team

get

Retrieve the feed for a specific channel, participant, or team, containing updates, and interactions.

Authorizations
Path parameters
workspaceIdstringRequired
feedIdstringRequired

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

Responses
200
OK
application/json
get
GET /workspaces/{workspaceId}/feeds/{feedId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "sort": "createdAt",
    "countOnly": false,
    "indexType": "channel",
    "indexId": "text",
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "itemType": "conversation",
    "itemTypes": [
      "conversation"
    ],
    "agentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "closed": true,
    "archived": true,
    "replyStatus": "noFollowUp",
    "seen": true,
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationName": "text",
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "participants": {
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "agents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "selectedValueIds": [
            "text"
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "valueDateBefore": "2025-07-03",
          "valueDateAfter": "2025-07-03"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2025-07-03T02:22:34.722Z",
    "dateTo": "2025-07-03T02:22:34.722Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true
  },
  "itemListOptions": {
    "sort": "createdAt",
    "reverse": true,
    "columns": [
      "contact"
    ]
  },
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ],
  "itemCount": 1
}

Updates Feed

patch

Perform an update on a given feed.

Authorizations
Path parameters
workspaceIdstringRequired
feedIdstringRequired

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

Body
namestringOptional
emojistringOptional
Responses
200
OK
application/json
patch
PATCH /workspaces/{workspaceId}/feeds/{feedId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 1813

{
  "name": "text",
  "emoji": "text",
  "query": {
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "sort": "createdAt",
    "countOnly": false,
    "indexType": "channel",
    "indexId": "text",
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "itemType": "conversation",
    "itemTypes": [
      "conversation"
    ],
    "agentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "closed": true,
    "archived": true,
    "replyStatus": "noFollowUp",
    "seen": true,
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationName": "text",
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "participants": {
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "agents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "selectedValueIds": [
            "text"
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "valueDateBefore": "2025-07-03",
          "valueDateAfter": "2025-07-03"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2025-07-03T02:22:34.722Z",
    "dateTo": "2025-07-03T02:22:34.722Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true
  },
  "itemListOptions": {
    "sort": "createdAt",
    "reverse": true,
    "columns": [
      "contact"
    ]
  },
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ]
}
{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "sort": "createdAt",
    "countOnly": false,
    "indexType": "channel",
    "indexId": "text",
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "itemType": "conversation",
    "itemTypes": [
      "conversation"
    ],
    "agentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "closed": true,
    "archived": true,
    "replyStatus": "noFollowUp",
    "seen": true,
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationName": "text",
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "participants": {
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "agents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "selectedValueIds": [
            "text"
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "valueDateBefore": "2025-07-03",
          "valueDateAfter": "2025-07-03"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2025-07-03T02:22:34.722Z",
    "dateTo": "2025-07-03T02:22:34.722Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true
  },
  "itemListOptions": {
    "sort": "createdAt",
    "reverse": true,
    "columns": [
      "contact"
    ]
  },
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ],
  "itemCount": 1
}

Delete Feed

delete

Permanently delete a feed.

Authorizations
Path parameters
workspaceIdstringRequired
feedIdstringRequired

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

Responses
204
Deleted
delete
DELETE /workspaces/{workspaceId}/feeds/{feedId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

List items for a channel, participant or team feed

get

Obtain a list of items within the feed.

Authorizations
Path parameters
workspaceIdstringRequired
feedIdstringRequired

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

Query parameters
limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10
pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false
sortBystring · enumOptional

Sort applied to the list

Possible values:
ticketNumbersnumber[]Optional

Filter by specific ticket number.

unassignedbooleanOptional

Search for feed items that have no agent assigned.

agentIdsstring · uuid[]Optional

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

teamIdsstring · uuid[]Optional

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

closedbooleanOptional

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

seenbooleanOptional

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

archivedbooleanOptional

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

tagIdsstring[]Optional

Search for feed items containing these tags.

conversationIdsstring · uuid[]Optional

Filter items for a specific conversation(s).

conversationChannelIdsstring · uuid[]Optional

Filter items for a specific conversation channel(s).

conversationNamestringOptional

Filter items for a specific conversation name containing the term.

conversationFeaturedParticipantIdsstring · uuid[]Optional

Participant IDs for conversation feed items.

conversationLastMessageSenderParticipantTypesstring · enumOptional

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.

Possible values:
Responses
200
OK
application/json
Responseall of
get
GET /workspaces/{workspaceId}/feeds/{feedId}/items HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "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,
      "type": "conversation",
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-07-03T02:22:34.722Z",
      "willBeDeletedAt": "2025-07-03T02:22:34.722Z",
      "lastActivityAt": "2025-07-03T02:22:34.722Z",
      "lastMessageByContactAt": "2025-07-03T02:22:34.722Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2025-07-03T02:22:34.722Z",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-07-03T02:22:34.722Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-07-03T02:22:34.722Z"
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "style": "default",
        "featuredParticipants": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "displayName": "John Doe",
            "avatarUrl": "https://example.bird.com/avatar-url",
            "contact": {
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          }
        ],
        "initiatingParticipant": {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "displayName": "John Doe",
          "avatarUrl": "https://example.bird.com/avatar-url",
          "contact": {
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "[email protected]",
            "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": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          },
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "type": "to",
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ],
          "draft": true,
          "createdAt": "2024-01-01T00:00:00.123Z"
        },
        "lastMessageIncomingAt": "2025-07-03T02:22:34.722Z",
        "lastMessageOutgoingAt": "2025-07-03T02:22:34.722Z",
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "platformStyle": "direct",
        "attributes": {
          "myCustomField": "abc"
        },
        "summary": "Re: Your refund request",
        "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": {
          "type": "task",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "hasDraft": true
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-07-03T02:22:34.722Z"
          }
        ]
      },
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "status": "text",
      "statusCategory": "new"
    }
  ],
  "total": 1,
  "nextPageToken": "text"
}

Updates items from a feed

patch

Perform bulk updates on multiple items within a feed, modifying their content, status, or other attributes.

Authorizations
Path parameters
workspaceIdstringRequired
feedIdstringRequired

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

Body
agentIdstring | nullableOptional
Responses
202
Accepted
patch
PATCH /workspaces/{workspaceId}/feeds/{feedId}/items HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "agentId": "text"
}

No content

Get individual feed for logged in agent

get

Retrieve the feed for currently logged in agent.

Authorizations
Path parameters
workspaceIdstringRequired
aliasstringRequired
Responses
200
OK
application/json
get
GET /workspaces/{workspaceId}/me/feeds/{alias} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "id": "text",
  "indexType": "text",
  "indexId": "text",
  "name": "text",
  "emoji": "text",
  "query": {
    "conversationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "sort": "createdAt",
    "countOnly": false,
    "indexType": "channel",
    "indexId": "text",
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ticketNumbers": [
      1
    ],
    "itemType": "conversation",
    "itemTypes": [
      "conversation"
    ],
    "agentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "closed": true,
    "archived": true,
    "replyStatus": "noFollowUp",
    "seen": true,
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationName": "text",
    "conversationChannelIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conversationStatuses": [
      "active"
    ],
    "conferenceStatuses": [
      "accepted"
    ],
    "participants": {
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "agents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "conversationParticipantTypes": [
      "user"
    ],
    "conversationExcludeParticipantTypes": [
      "user"
    ],
    "conversationLastMessageSenderParticipantTypes": [
      "user"
    ],
    "fromContact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "selectedValueIds": [
            "text"
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "valueDateBefore": "2025-07-03",
          "valueDateAfter": "2025-07-03"
        }
      ]
    },
    "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
    "itemStatuses": [
      "open"
    ],
    "dateFrom": "2025-07-03T02:22:34.722Z",
    "dateTo": "2025-07-03T02:22:34.722Z",
    "searchTerm": "text",
    "slaPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSlaPolicy": true,
    "slaPolicyStatus": "ok",
    "slaMetric": "firstReplyTime",
    "query": {
      "operator": "and",
      "children": [
        {
          "operator": "and",
          "children": "[Circular Reference]"
        }
      ]
    },
    "spam": true
  },
  "itemListOptions": {
    "sort": "createdAt",
    "reverse": true,
    "columns": [
      "contact"
    ]
  },
  "accessEntities": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "inbox-team"
    }
  ],
  "itemCount": 1
}

List items for logged in agent's individual feed

get

Obtain a list of items within the feed of currently logged in agent.

Authorizations
Path parameters
workspaceIdstringRequired
aliasstringRequired
Query parameters
limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10
pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false
Responses
200
OK
application/json
Responseall of
get
GET /workspaces/{workspaceId}/me/feeds/{alias}/items HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "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,
      "type": "conversation",
      "archived": true,
      "closed": true,
      "private": true,
      "deleted": true,
      "spam": true,
      "senderBlocked": true,
      "seen": true,
      "seenBy": "123e4567-e89b-12d3-a456-426614174000",
      "replySuggestion": "text",
      "createdAt": "2025-07-03T02:22:34.722Z",
      "willBeDeletedAt": "2025-07-03T02:22:34.722Z",
      "lastActivityAt": "2025-07-03T02:22:34.722Z",
      "lastMessageByContactAt": "2025-07-03T02:22:34.722Z",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "status": "draft",
          "addedAt": "2025-07-03T02:22:34.722Z",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "emoji": "text"
          }
        }
      ],
      "attributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "filters": [
        [
          {
            "key": "text",
            "value": "text"
          }
        ]
      ],
      "linkedItems": [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "linkedTo",
          "itemId": "123e4567-e89b-12d3-a456-426614174000",
          "itemNumber": 1,
          "itemSubject": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      ],
      "mergeInfo": {
        "mergedFrom": [
          {
            "userId": "text",
            "itemId": "text",
            "createdAt": "2025-07-03T02:22:34.722Z"
          }
        ],
        "mergedInto": {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      },
      "dynamicFields": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "summaryForm": {
        "settingsId": "text",
        "fields": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "type": "single",
            "values": [
              {
                "id": "text",
                "value": "text",
                "icon": "text",
                "createdAt": "2025-07-03T02:22:34.722Z",
                "selected": true
              }
            ],
            "valueText": "text",
            "valueNumber": 1,
            "valueBoolean": true,
            "valueDate": "2025-07-03",
            "settings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "queueInfo": {
        "queueId": "123e4567-e89b-12d3-a456-426614174000",
        "queueName": "text",
        "queuedAt": "2025-07-03T02:22:34.722Z"
      },
      "conversation": {
        "id": "299227f5-1c61-4341-ad50-efed5c048998",
        "name": "Re: Your refund request",
        "description": "Refund request ticket",
        "status": "active",
        "visibility": "public",
        "accessibility": "open",
        "style": "default",
        "featuredParticipants": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "displayName": "John Doe",
            "avatarUrl": "https://example.bird.com/avatar-url",
            "contact": {
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          }
        ],
        "initiatingParticipant": {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "displayName": "John Doe",
          "avatarUrl": "https://example.bird.com/avatar-url",
          "contact": {
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "[email protected]",
            "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": "[email protected]",
              "platformAddress": "[email protected]",
              "platformAddressSelector": "attributes.workEmail"
            },
            "type": "user",
            "status": "active"
          },
          "recipients": [
            {
              "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
              "type": "to",
              "identifierKey": "emailaddress",
              "identifierValue": "[email protected]",
              "platformAddress": "text",
              "platformAddressSelector": "attributes.workEmail",
              "contactAnnotation": {
                "name": "John Doe"
              }
            }
          ],
          "draft": true,
          "createdAt": "2024-01-01T00:00:00.123Z"
        },
        "lastMessageIncomingAt": "2025-07-03T02:22:34.722Z",
        "lastMessageOutgoingAt": "2025-07-03T02:22:34.722Z",
        "createdAt": "2024-01-01T00:00:00.123Z",
        "updatedAt": "2024-01-01T00:00:00.123Z",
        "platformStyle": "direct",
        "attributes": {
          "myCustomField": "abc"
        },
        "summary": "Re: Your refund request",
        "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": {
          "type": "task",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "hasDraft": true
      },
      "conference": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "task": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "slaPolicy": {
        "policyId": "123e4567-e89b-12d3-a456-426614174000",
        "timers": [
          {
            "metric": "firstReplyTime",
            "severity": "breach",
            "status": "inactive",
            "expiresAt": "2025-07-03T02:22:34.722Z"
          }
        ]
      },
      "requiredSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "status": "text",
      "statusCategory": "new"
    }
  ],
  "total": 1,
  "nextPageToken": "text"
}

Get Feed Item By a specific filter

get

Retrieve information about a specific item.

Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
ticketNumberinteger · min: 1Required

Ticket number

Responses
200
OK
application/json
get
GET /workspaces/{workspaceId}/feeds/items?ticketNumber=1 HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "type": "conversation"
}

Get Feed Item By Root Item ID

get

Retrieve information about a specific item.

Authorizations
Path parameters
workspaceIdstringRequired
itemIdstringRequired

Feed Item UUID

Responses
200
OK
application/json
get
GET /workspaces/{workspaceId}/feeds/items/{itemId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "type": "conversation"
}

Get Feed Item

get

Retrieve information about a specific item within a feed.

Authorizations
Path parameters
workspaceIdstringRequired
itemIdstringRequired

Feed Item UUID

feedIdstringRequired

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

Responses
200
OK
application/json
get
GET /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "id": "text",
  "feedId": "text",
  "feedIndexId": "text",
  "feedIndexType": "text",
  "agent": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "team": {
    "id": "text",
    "name": "text",
    "avatarUrl": "text"
  },
  "number": 1,
  "type": "conversation",
  "archived": true,
  "closed": true,
  "private": true,
  "deleted": true,
  "spam": true,
  "senderBlocked": true,
  "seen": true,
  "seenBy": "123e4567-e89b-12d3-a456-426614174000",
  "replySuggestion": "text",
  "createdAt": "2025-07-03T02:22:34.722Z",
  "willBeDeletedAt": "2025-07-03T02:22:34.722Z",
  "lastActivityAt": "2025-07-03T02:22:34.722Z",
  "lastMessageByContactAt": "2025-07-03T02:22:34.722Z",
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "status": "draft",
      "addedAt": "2025-07-03T02:22:34.722Z",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "emoji": "text"
      }
    }
  ],
  "attributes": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "filters": [
    [
      {
        "key": "text",
        "value": "text"
      }
    ]
  ],
  "linkedItems": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "relation": "linkedTo",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "itemNumber": 1,
      "itemSubject": "text",
      "createdAt": "2025-07-03T02:22:34.722Z"
    }
  ],
  "mergeInfo": {
    "mergedFrom": [
      {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-07-03T02:22:34.722Z"
      }
    ],
    "mergedInto": {
      "userId": "text",
      "itemId": "text",
      "createdAt": "2025-07-03T02:22:34.722Z"
    }
  },
  "dynamicFields": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-07-03T02:22:34.722Z",
            "selected": true
          }
        ],
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-07-03",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "summaryForm": {
    "settingsId": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "createdAt": "2025-07-03T02:22:34.722Z",
            "selected": true
          }
        ],
        "valueText": "text",
        "valueNumber": 1,
        "valueBoolean": true,
        "valueDate": "2025-07-03",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "queueInfo": {
    "queueId": "123e4567-e89b-12d3-a456-426614174000",
    "queueName": "text",
    "queuedAt": "2025-07-03T02:22:34.722Z"
  },
  "conversation": {
    "id": "299227f5-1c61-4341-ad50-efed5c048998",
    "name": "Re: Your refund request",
    "description": "Refund request ticket",
    "status": "active",
    "visibility": "public",
    "accessibility": "open",
    "style": "default",
    "featuredParticipants": [
      {
        "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
        "displayName": "John Doe",
        "avatarUrl": "https://example.bird.com/avatar-url",
        "contact": {
          "identifierKey": "emailaddress",
          "identifierValue": "[email protected]",
          "platformAddress": "[email protected]",
          "platformAddressSelector": "attributes.workEmail"
        },
        "type": "user",
        "status": "active"
      }
    ],
    "initiatingParticipant": {
      "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
      "displayName": "John Doe",
      "avatarUrl": "https://example.bird.com/avatar-url",
      "contact": {
        "identifierKey": "emailaddress",
        "identifierValue": "[email protected]",
        "platformAddress": "[email protected]",
        "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": "[email protected]",
          "platformAddress": "[email protected]",
          "platformAddressSelector": "attributes.workEmail"
        },
        "type": "user",
        "status": "active"
      },
      "recipients": [
        {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "type": "to",
          "identifierKey": "emailaddress",
          "identifierValue": "[email protected]",
          "platformAddress": "text",
          "platformAddressSelector": "attributes.workEmail",
          "contactAnnotation": {
            "name": "John Doe"
          }
        }
      ],
      "draft": true,
      "createdAt": "2024-01-01T00:00:00.123Z"
    },
    "lastMessageIncomingAt": "2025-07-03T02:22:34.722Z",
    "lastMessageOutgoingAt": "2025-07-03T02:22:34.722Z",
    "createdAt": "2024-01-01T00:00:00.123Z",
    "updatedAt": "2024-01-01T00:00:00.123Z",
    "platformStyle": "direct",
    "attributes": {
      "myCustomField": "abc"
    },
    "summary": "Re: Your refund request",
    "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": {
      "type": "task",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "hasDraft": true
  },
  "conference": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "task": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "slaPolicy": {
    "policyId": "123e4567-e89b-12d3-a456-426614174000",
    "timers": [
      {
        "metric": "firstReplyTime",
        "severity": "breach",
        "status": "inactive",
        "expiresAt": "2025-07-03T02:22:34.722Z"
      }
    ]
  },
  "requiredSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "status": "text",
  "statusCategory": "new"
}

Update Feed Item

patch

Modify the content of a specific item within a feed.

Authorizations
Path parameters
workspaceIdstringRequired
itemIdstringRequired

Feed Item UUID

feedIdstringRequired

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

Body
agentIdstring | nullableOptional
teamIdstring | nullableOptional
archivedboolean | nullableOptional
spamboolean | nullableOptional
blockSenderboolean | nullableOptional
closedboolean | nullableOptional
seenbooleanOptional
privateboolean | nullableOptional
replySuggestionstringOptional
slaPolicyIdstring · uuid | nullableOptional
statusstringOptional

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

Responses
200
Updated
application/json
patch
PATCH /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 930

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

Add item to a feed

post

Add an existent item to an existent feed.

Authorizations
Path parameters
workspaceIdstringRequired
itemIdstringRequired

Feed Item UUID

feedIdstringRequired

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

Body
objectOptional
Responses
201
Created
application/json
post
POST /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 2

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

Remove item from feed

delete

Removes an item from a feed.

Authorizations
Path parameters
workspaceIdstringRequired
itemIdstringRequired

Feed Item UUID

feedIdstringRequired

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

Responses
204
Deleted
delete
DELETE /workspaces/{workspaceId}/feeds/{feedId}/items/{itemId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Merges this feed item into another one

post

Merges the feed item in the URL into the one specified in the request body.

Authorizations
Path parameters
workspaceIdstringRequired
feedIdstringRequired

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

Body
Responses
200
Ok
application/json
post
POST /workspaces/{workspaceId}/feeds/{feedId}/merge-items HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 2001

{
  "mergeFrom": {
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "message": {
      "reference": "text",
      "participantId": "text",
      "participantType": "user",
      "recipients": [
        {
          "id": "text",
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text",
          "type": "to"
        }
      ],
      "addMissingParticipants": true,
      "body": {
        "type": "text",
        "text": {
          "text": "text",
          "attachments": [
            {
              "mediaUrl": "https://example.com",
              "filename": "text",
              "inline": true,
              "contentId": "text"
            }
          ],
          "actions": [
            {
              "type": "link",
              "link": {
                "text": "text",
                "url": "text"
              }
            }
          ],
          "metadata": {
            "subject": "text",
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "whatsapp": {
              "previewUrl": true
            },
            "line": {
              "emoji": {
                "items": [
                  {
                    "index": 1,
                    "productId": "text",
                    "emojiId": "text"
                  }
                ]
              }
            },
            "telegram": {
              "parseMode": "Markdown"
            }
          }
        }
      }
    },
    "comment": {
      "body": {
        "type": "text",
        "text": {
          "text": "text"
        }
      },
      "mentions": {
        "notify": {
          "onUpdate": false,
          "onDelete": false
        },
        "identifiers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "replyTo": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "comment"
      }
    }
  },
  "mergeInto": {
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "message": {
      "reference": "text",
      "participantId": "text",
      "participantType": "user",
      "recipients": [
        {
          "id": "text",
          "identifierKey": "text",
          "identifierValue": "text",
          "platformAddress": "text",
          "platformAddressSelector": "text",
          "type": "to"
        }
      ],
      "addMissingParticipants": true,
      "body": {
        "type": "text",
        "text": {
          "text": "text",
          "attachments": [
            {
              "mediaUrl": "https://example.com",
              "filename": "text",
              "inline": true,
              "contentId": "text"
            }
          ],
          "actions": [
            {
              "type": "link",
              "link": {
                "text": "text",
                "url": "text"
              }
            }
          ],
          "metadata": {
            "subject": "text",
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "whatsapp": {
              "previewUrl": true
            },
            "line": {
              "emoji": {
                "items": [
                  {
                    "index": 1,
                    "productId": "text",
                    "emojiId": "text"
                  }
                ]
              }
            },
            "telegram": {
              "parseMode": "Markdown"
            }
          }
        }
      }
    },
    "comment": {
      "body": {
        "type": "text",
        "text": {
          "text": "text"
        }
      },
      "mentions": {
        "notify": {
          "onUpdate": false,
          "onDelete": false
        },
        "identifiers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "replyTo": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "comment"
      }
    }
  }
}
{
  "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,
    "type": "conversation",
    "archived": true,
    "closed": true,
    "private": true,
    "deleted": true,
    "spam": true,
    "senderBlocked": true,
    "seen": true,
    "seenBy": "123e4567-e89b-12d3-a456-426614174000",
    "replySuggestion": "text",
    "createdAt": "2025-07-03T02:22:34.722Z",
    "willBeDeletedAt": "2025-07-03T02:22:34.722Z",
    "lastActivityAt": "2025-07-03T02:22:34.722Z",
    "lastMessageByContactAt": "2025-07-03T02:22:34.722Z",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "status": "draft",
        "addedAt": "2025-07-03T02:22:34.722Z",
        "category": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "emoji": "text"
        }
      }
    ],
    "attributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "filters": [
      [
        {
          "key": "text",
          "value": "text"
        }
      ]
    ],
    "linkedItems": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": "linkedTo",
        "itemId": "123e4567-e89b-12d3-a456-426614174000",
        "itemNumber": 1,
        "itemSubject": "text",
        "createdAt": "2025-07-03T02:22:34.722Z"
      }
    ],
    "mergeInfo": {
      "mergedFrom": [
        {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      ],
      "mergedInto": {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-07-03T02:22:34.722Z"
      }
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-07-03T02:22:34.722Z",
              "selected": true
            }
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ]
    },
    "summaryForm": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-07-03T02:22:34.722Z",
              "selected": true
            }
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ]
    },
    "queueInfo": {
      "queueId": "123e4567-e89b-12d3-a456-426614174000",
      "queueName": "text",
      "queuedAt": "2025-07-03T02:22:34.722Z"
    },
    "conversation": {
      "id": "299227f5-1c61-4341-ad50-efed5c048998",
      "name": "Re: Your refund request",
      "description": "Refund request ticket",
      "status": "active",
      "visibility": "public",
      "accessibility": "open",
      "style": "default",
      "featuredParticipants": [
        {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "displayName": "John Doe",
          "avatarUrl": "https://example.bird.com/avatar-url",
          "contact": {
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "[email protected]",
            "platformAddressSelector": "attributes.workEmail"
          },
          "type": "user",
          "status": "active"
        }
      ],
      "initiatingParticipant": {
        "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
        "displayName": "John Doe",
        "avatarUrl": "https://example.bird.com/avatar-url",
        "contact": {
          "identifierKey": "emailaddress",
          "identifierValue": "[email protected]",
          "platformAddress": "[email protected]",
          "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": "[email protected]",
            "platformAddress": "[email protected]",
            "platformAddressSelector": "attributes.workEmail"
          },
          "type": "user",
          "status": "active"
        },
        "recipients": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "type": "to",
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "text",
            "platformAddressSelector": "attributes.workEmail",
            "contactAnnotation": {
              "name": "John Doe"
            }
          }
        ],
        "draft": true,
        "createdAt": "2024-01-01T00:00:00.123Z"
      },
      "lastMessageIncomingAt": "2025-07-03T02:22:34.722Z",
      "lastMessageOutgoingAt": "2025-07-03T02:22:34.722Z",
      "createdAt": "2024-01-01T00:00:00.123Z",
      "updatedAt": "2024-01-01T00:00:00.123Z",
      "platformStyle": "direct",
      "attributes": {
        "myCustomField": "abc"
      },
      "summary": "Re: Your refund request",
      "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": {
        "type": "task",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "hasDraft": true
    },
    "conference": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "task": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "slaPolicy": {
      "policyId": "123e4567-e89b-12d3-a456-426614174000",
      "timers": [
        {
          "metric": "firstReplyTime",
          "severity": "breach",
          "status": "inactive",
          "expiresAt": "2025-07-03T02:22:34.722Z"
        }
      ]
    },
    "requiredSkills": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "valueType": "single",
        "selectedValues": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "value": "text",
            "icon": "text"
          }
        ]
      }
    ],
    "status": "text",
    "statusCategory": "new"
  },
  "mergedInto": {
    "id": "text",
    "feedId": "text",
    "feedIndexId": "text",
    "feedIndexType": "text",
    "agent": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "team": {
      "id": "text",
      "name": "text",
      "avatarUrl": "text"
    },
    "number": 1,
    "type": "conversation",
    "archived": true,
    "closed": true,
    "private": true,
    "deleted": true,
    "spam": true,
    "senderBlocked": true,
    "seen": true,
    "seenBy": "123e4567-e89b-12d3-a456-426614174000",
    "replySuggestion": "text",
    "createdAt": "2025-07-03T02:22:34.722Z",
    "willBeDeletedAt": "2025-07-03T02:22:34.722Z",
    "lastActivityAt": "2025-07-03T02:22:34.722Z",
    "lastMessageByContactAt": "2025-07-03T02:22:34.722Z",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "status": "draft",
        "addedAt": "2025-07-03T02:22:34.722Z",
        "category": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "emoji": "text"
        }
      }
    ],
    "attributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "filters": [
      [
        {
          "key": "text",
          "value": "text"
        }
      ]
    ],
    "linkedItems": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": "linkedTo",
        "itemId": "123e4567-e89b-12d3-a456-426614174000",
        "itemNumber": 1,
        "itemSubject": "text",
        "createdAt": "2025-07-03T02:22:34.722Z"
      }
    ],
    "mergeInfo": {
      "mergedFrom": [
        {
          "userId": "text",
          "itemId": "text",
          "createdAt": "2025-07-03T02:22:34.722Z"
        }
      ],
      "mergedInto": {
        "userId": "text",
        "itemId": "text",
        "createdAt": "2025-07-03T02:22:34.722Z"
      }
    },
    "dynamicFields": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-07-03T02:22:34.722Z",
              "selected": true
            }
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ]
    },
    "summaryForm": {
      "settingsId": "text",
      "fields": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "type": "single",
          "values": [
            {
              "id": "text",
              "value": "text",
              "icon": "text",
              "createdAt": "2025-07-03T02:22:34.722Z",
              "selected": true
            }
          ],
          "valueText": "text",
          "valueNumber": 1,
          "valueBoolean": true,
          "valueDate": "2025-07-03",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ]
    },
    "queueInfo": {
      "queueId": "123e4567-e89b-12d3-a456-426614174000",
      "queueName": "text",
      "queuedAt": "2025-07-03T02:22:34.722Z"
    },
    "conversation": {
      "id": "299227f5-1c61-4341-ad50-efed5c048998",
      "name": "Re: Your refund request",
      "description": "Refund request ticket",
      "status": "active",
      "visibility": "public",
      "accessibility": "open",
      "style": "default",
      "featuredParticipants": [
        {
          "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
          "displayName": "John Doe",
          "avatarUrl": "https://example.bird.com/avatar-url",
          "contact": {
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "[email protected]",
            "platformAddressSelector": "attributes.workEmail"
          },
          "type": "user",
          "status": "active"
        }
      ],
      "initiatingParticipant": {
        "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
        "displayName": "John Doe",
        "avatarUrl": "https://example.bird.com/avatar-url",
        "contact": {
          "identifierKey": "emailaddress",
          "identifierValue": "[email protected]",
          "platformAddress": "[email protected]",
          "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": "[email protected]",
            "platformAddress": "[email protected]",
            "platformAddressSelector": "attributes.workEmail"
          },
          "type": "user",
          "status": "active"
        },
        "recipients": [
          {
            "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
            "type": "to",
            "identifierKey": "emailaddress",
            "identifierValue": "[email protected]",
            "platformAddress": "text",
            "platformAddressSelector": "attributes.workEmail",
            "contactAnnotation": {
              "name": "John Doe"
            }
          }
        ],
        "draft": true,
        "createdAt": "2024-01-01T00:00:00.123Z"
      },
      "lastMessageIncomingAt": "2025-07-03T02:22:34.722Z",
      "lastMessageOutgoingAt": "2025-07-03T02:22:34.722Z",
      "createdAt": "2024-01-01T00:00:00.123Z",
      "updatedAt": "2024-01-01T00:00:00.123Z",
      "platformStyle": "direct",
      "attributes": {
        "myCustomField": "abc"
      },
      "summary": "Re: Your refund request",
      "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": {
        "type": "task",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "hasDraft": true
    },
    "conference": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "task": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "slaPolicy": {
      "policyId": "123e4567-e89b-12d3-a456-426614174000",
      "timers": [
        {
          "metric": "firstReplyTime",
          "severity": "breach",
          "status": "inactive",
          "expiresAt": "2025-07-03T02:22:34.722Z"
        }
      ]
    },
    "requiredSkills": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "valueType": "single",
        "selectedValues": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "value": "text",
            "icon": "text"
          }
        ]
      }
    ],
    "status": "text",
    "statusCategory": "new"
  },
  "mergedFromMessageSentId": "123e4567-e89b-12d3-a456-426614174000",
  "mergedIntoMessageSentId": "123e4567-e89b-12d3-a456-426614174000",
  "mergedFromCommentCreatedId": "123e4567-e89b-12d3-a456-426614174000",
  "mergedIntoCommentCreatedId": "123e4567-e89b-12d3-a456-426614174000"
}

Last updated

Was this helpful?