DocumentationEngagement Platform API
Sign inGet started
Guides
API

Update conversation

PATCH
/workspaces/{workspaceId}/conversations/{conversationId}
Update a conversation's properties
Corps de la requête
name
string
Name of the conversation. If it's an email channel, this will correspond to the email subject.
description
string
status
string
Possible values: deleted, active, closed, spam, archived
visibility
string
Possible values: public, private, direct, group
accessibility
string
Possible values: open, invite-only, request-to-join, private
attributes
object
A free-form object containing conversation attributes. You can use this field to store custom information along with the conversation.
resource
object
Resource reference
Afficher les paramètres enfants
resource.type
string
The type of referenced resource
Possible values: task, task-conversation, reimbursement, expense, sales-lead, sales-opportunity, sales-account, project
resource.id
string
The ID of the referenced resource.
Corps de la réponse
accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
activeParticipantCount
integer
obligatoire
assigneeId
string
attributes
object
category
string
channelId
string
obligatoire
createdAt
string
obligatoire
description
string
directory
string
featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
featuredParticipants.avatarUrl
string
featuredParticipants.contact
object
Afficher les attributs enfants
featuredParticipants.contact.identifierKey
string
obligatoire
featuredParticipants.contact.identifierValue
string
obligatoire
featuredParticipants.contact.platformAddress
string
featuredParticipants.contact.platformAddressSelector
string
featuredParticipants.conversationId
string
featuredParticipants.createdAt
string
featuredParticipants.displayName
string
featuredParticipants.id
string
obligatoire
featuredParticipants.resourceUri
string
featuredParticipants.status
string
Possible values: invited, pending, active, inactive
featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
featuredParticipants.updatedAt
string
hasDraft
boolean
id
string
obligatoire
inbox
object
Afficher les attributs enfants
inbox.id
string
obligatoire
inbox.identifier
string
obligatoire
inbox.ownerId
string
obligatoire
inbox.ownerType
string
obligatoire
Possible values: user, group
inbox.type
string
obligatoire
Possible values: personal, shared, support
initiatingParticipant
object
Afficher les attributs enfants
initiatingParticipant.avatarUrl
string
initiatingParticipant.contact
object
Afficher les attributs enfants
initiatingParticipant.contact.identifierKey
string
obligatoire
initiatingParticipant.contact.identifierValue
string
obligatoire
initiatingParticipant.contact.platformAddress
string
initiatingParticipant.contact.platformAddressSelector
string
initiatingParticipant.conversationId
string
initiatingParticipant.createdAt
string
initiatingParticipant.displayName
string
initiatingParticipant.id
string
obligatoire
initiatingParticipant.resourceUri
string
initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
initiatingParticipant.updatedAt
string
lastMessage
object
Afficher les attributs enfants
lastMessage.createdAt
string
obligatoire
lastMessage.draft
boolean
obligatoire
lastMessage.id
string
obligatoire
lastMessage.preview
object
obligatoire
Afficher les attributs enfants
lastMessage.preview.text
string
lastMessage.recipients
array of object
Afficher les attributs enfants
lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
lastMessage.recipients.contactAnnotation.name
string
lastMessage.recipients.countryCode
string
lastMessage.recipients.id
string
The ID of the contact.
lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
lastMessage.recipients.receiverExpression
string
lastMessage.recipients.receiverValue
string
lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
lastMessage.sender
object
Afficher les attributs enfants
lastMessage.sender.email
string
lastMessage.sender.name
string
lastMessage.sender.avatarUrl
string
lastMessage.sender.contact
object
Afficher les attributs enfants
lastMessage.sender.contact.identifierKey
string
obligatoire
lastMessage.sender.contact.identifierValue
string
obligatoire
lastMessage.sender.contact.platformAddress
string
lastMessage.sender.contact.platformAddressSelector
string
lastMessage.sender.conversationId
string
lastMessage.sender.createdAt
string
lastMessage.sender.displayName
string
lastMessage.sender.id
string
obligatoire
lastMessage.sender.resourceUri
string
lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
lastMessage.sender.updatedAt
string
lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
lastMessageIncomingAt
string
lastMessageOutgoingAt
string
name
string
obligatoire
participants
array of object
Afficher les attributs enfants
participants.contact
object
Afficher les attributs enfants
participants.contact.identifierKey
string
obligatoire
participants.contact.identifierValue
string
obligatoire
participants.contact.platformAddress
string
participants.contact.platformAddressSelector
string
participants.id
string
obligatoire
participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
pendingParticipantCount
integer
platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
privateAttributes
string
read
boolean
referral
object
Afficher les attributs enfants
referral.caption
string
referral.mediaType
string
referral.mediaUrl
string
referral.sourceId
string
obligatoire
referral.sourceType
string
referral.sourceUrl
string
referral.text
string
referral.timestamp
string
referral.title
string
referral.username
string
resource
object
Afficher les attributs enfants
resource.id
string
obligatoire
resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
resourceUri
string
starred
boolean
status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
summary
string
tags
array of string
updatedAt
string
obligatoire
visibility
string
obligatoire
Possible values: public, private, direct, group
Exemple de code
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Exemple de code
curl -X PATCH "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/907798f8-fd72-44d5-8042-fcc05c1bb570" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "name": "new name",
  "description": "description",
  "visibility": "private",
  "attributes": {
    "my-attribute": "123"
  }
}'