v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB

Messages

Conversation information

This endpoint returns all information on a specific Conversation.

get/conversations/{conversation_id}

Path parameters

conversation_idinteger required

The id of the conversation to fetch

Response

idinteger

consumer_imgstring url nullable

The url of the consumer's profile picture

consumer_namestring nullable

The name of the consumer, can be empty. The format may differ depending on the platform of contact (ex: "John Doe", "John Doe (@johndoe)", "@johndoe", "", ...).

consumer_phone_numberstring nullable

The phone number of the consumer, formatted in E.164 international format (ex: "+33612345678").

consumer_emailstring nullable

The email of the consumer.

is_readboolean

If the last message received was read. This property is scoped to the user who performs the request. Multiple partoo users can have a different is_read value for the same conversation. is_read is always false in webhook payloads.

status'Open' | 'Closed'

If Open, it is possible to send a message in the conversation, else not. A conversation can be Closed if it is expired.

created_atstring

The date of creation of the conversation, in the ISO 8601 format (ex: "2023-01-31 16:22:17.327878+00:00").

has_one_user_messageboolean

If the conversation has at least one message sent by a Partoo user.

The channel that the message is being sent to/from.

⚠️ New values may be added to this enum without prior notice and without following the classic depreciation cycle.
It is up to you to gracefully handle the case where new values are added.

issuesConversationIssue[]

The list of issues that affect the conversation. The issues represent setup problem that the business may have with a messaging channel. It is not possible to send messages on a conversation that has issues.

⚠️ New values may be added to this enum without prior notice and without following the classic depreciation cycle.
It is up to you to gracefully handle the case where new values are added.

first_message_datestring

The date at which the first message of the conversation was received, in the ISO 8601 format (ex: "2023-01-31 16:22:17.327878+00:00").

is_expiredboolean

If the conversation has expired. A conversation expires if the consumer has not contacted the business for a certain amount of time.
You cannot send messages to an expired conversation.

is_solvedboolean

If the conversation has been solved.
Conversations can be solved from our app or by updating conversation status to "closed".

is_automatedboolean

If a Partoo chatbot is assigned to the conversation.

assigned_user_idstring nullable

The "user_id" of the user assigned to the conversation.

Example response

{
  "consumer_img": "https://www.example.com/profile-picture.jpg",
  "consumer_name": "John Doe",
  "consumer_phone_number": "+33612345678",
  "consumer_email": "john.doe@example.com",
  "last_message": {
    "date": "2023-01-31 16:22:17.327878+00:00",
    "sender_label": "Jane Doe"
  },
  "created_at": "2023-01-31 16:22:17.327878+00:00",
  "messaging_partner": "Facebook",
  "issues": [
    "facebook_no_page_linked"
  ],
  "assigned_user_id": "62d80fae74e8b11d700302b8"
}