BUbundle
conversation

Update conversation

Changed on

Set the status of a conversation. This is the general form of the archive and open endpoints, which move a conversation to one specific status.

patch/api/v1/conversations/{id}

Request

  • Base URL
    https://api.bundle.social
  • URL
    https://api.bundle.social/api/v1/conversations/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Request body

status'OPEN' | 'ARCHIVED' required

Response

200

idstring required
teamIdstring required
socialAccountIdstring required
platform'INSTAGRAM' | 'FACEBOOK' required

Messaging platform. Extensible: new platforms are added over time, so handle unknown values gracefully rather than switching exhaustively.

externalConversationIdstring nullable
externalParticipantIdstring required
participantUsernamestring nullable
participantDisplayNamestring nullable
participantAvatarUrlstring nullable
status'OPEN' | 'ARCHIVED' required
lastMessageAtstring date-time nullable
lastActivityAtstring date-time nullable required
lastMessagePreviewstring nullable
lastReadAtstring date-time nullable
unreadCountnumber required
platformSeenAtstring date-time nullable
createdAtstring date-time nullable required
updatedAtstring date-time nullable required

Changes