Client API · Conversations
Resolve a conversation
POST/
Marks a conversation as resolved
Path parameters
inbox_identifierstringrequiredThe identifier obtained from API inbox channel
contact_identifierstringrequiredThe source id of contact obtained on contact create
conversation_idintegerrequiredThe numeric ID of the conversation
Responses
200Conversation resolved successfully
idintegerId of the conversation
uuidstringUUID of the conversation
inbox_idintegerThe inbox id of the conversation
contact_last_seen_atintegerTimestamp of when the contact last seen the conversation (Unix timestamp)
statusstringThe status of the conversation One of: open, resolved, pending, snoozed.
agent_last_seen_atintegerTimestamp of when the agent last seen the conversation (Unix timestamp)
messagesarray of objectMessages in the conversation
messages[].idintegerId of the message
messages[].contentstringText content of the message. Can be null for attachment-only messages.
messages[].message_typeintegerDenotes the message type. Possible values: 0 (incoming), 1 (outgoing), 2 (activity), 3 (template)
messages[].content_typestringContent type of the message
messages[].content_attributesobjectAdditional content attributes of the message
messages[].created_atintegerCreated at Unix timestamp of the message
messages[].conversation_idintegerDisplay Id of the conversation the message belongs to
messages[].attachmentsarray of objectAttachments if any
messages[].attachments[].idintegerId of the attachment
messages[].attachments[].message_idintegerId of the parent message
messages[].attachments[].file_typestringType of the attached file One of: image, audio, video, file, location, fallback, share, story_mention, contact, ig_reel, ig_post, ig_story, embed.
messages[].attachments[].account_idintegerId of the account
messages[].attachments[].extensionstringFile extension
messages[].attachments[].data_urlstringURL of the file. Can be null when an attachment variant has no external URL.
messages[].attachments[].thumb_urlstringURL of the file thumbnail
messages[].attachments[].file_sizeintegerFile size in bytes
messages[].attachments[].widthintegerWidth of the attachment when available
messages[].attachments[].heightintegerHeight of the attachment when available
messages[].attachments[].coordinates_latnumberLatitude for location attachments
messages[].attachments[].coordinates_longnumberLongitude for location attachments
messages[].attachments[].fallback_titlestringFallback title for location, fallback, and contact attachments when available
messages[].attachments[].metaobjectMetadata for contact attachments
messages[].attachments[].transcribed_textstringTranscribed text for audio attachments
messages[].senderobjectPolymorphic sender payload returned by push_event_data. Available fields vary by sender type.
messages[].sender.idintegerId of the sender
messages[].sender.namestringName of the sender when available
messages[].sender.thumbnailstringAvatar/thumbnail URL of the sender. Contact senders use this field; user senders may also include it.
messages[].sender.typestringType of the sender One of: contact, user, agent_bot.
messages[].sender.available_namestringDisplay name for user senders
messages[].sender.availability_statusstringAvailability status for user senders
messages[].sender.emailstringEmail of the sender when the sender is a contact
messages[].sender.phone_numberstringPhone number of the sender when the sender is a contact
messages[].sender.identifierstringIdentifier of the sender when the sender is a contact
messages[].sender.blockedbooleanWhether the sender is blocked when the sender is a contact
messages[].sender.additional_attributesobjectAdditional attributes when the sender is a contact and available
messages[].sender.custom_attributesobjectCustom attributes when the sender is a contact and available
contactobjectFull serialized contact record returned when the public API renders a Contact model directly.
contact.idintegerId of the contact
contact.namestringName of the contact when available
contact.emailstringEmail of the contact
contact.phone_numberstringPhone number of the contact
contact.identifierstringIdentifier of the contact
contact.blockedbooleanWhether the contact is blocked
contact.additional_attributesobjectAdditional attributes of the contact when present
contact.custom_attributesobjectCustom attributes of the contact when present
contact.contact_typestringContact type of the contact when available
contact.country_codestringCountry code of the contact
contact.last_activity_atstringLast activity timestamp of the contact in ISO 8601 format
contact.created_atstringCreated timestamp of the contact in ISO 8601 format
contact.updated_atstringUpdated timestamp of the contact in ISO 8601 format
contact.last_namestringLast name of the contact
contact.middle_namestringMiddle name of the contact
contact.locationstringLocation of the contact
contact.account_idintegerAccount id of the contact
contact.company_idintegerCompany id of the contact
contact.label_listarray of stringLabels applied to the contact
401Unauthorized
descriptionstringerrorsarray of objecterrors[].fieldstringerrors[].messagestringerrors[].codestring404Conversation not found
descriptionstringerrorsarray of objecterrors[].fieldstringerrors[].messagestringerrors[].codestring