M10 - Retrieve a thread

Request

Call Frequency

Recommended usage: Synchronous only - At each page that includes a message thread display

Maximum usage: Synchronous only - At each page that includes a message thread display

Path

thread_idstringrequired

The identifier of the thread to retrieve.

Query

customer_idstring

Customer id associated to the thread. If specified the response will contain only messages visible by the customer. This param should be typically filled when calling this API during a customer account integration. Not specifying this parameter will return all messages of the thread. Useful when you want to synchronize all messaging data with your IT system.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/inbox/threads/{thread_id}?customer_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

authorized_participantsArray of objectsrequired

Thread authorized participants
Those are the participants who are authorized to join the thread.

current_participantsArray of objectsrequired

Thread current participants
Those are the participants who have actually participated in the thread, meaning that they are either sender or receivers of at least one message of the thread.
These participants must be on the list of the authorized_participants

customer_organizationobject

Data related to the customer organization (B2B transactions)

date_createdstring, (date-time)required

Thread created date

date_updatedstring, (date-time)required

Thread updated date

entitiesArray of objects

Thread entities

idstringrequired

Thread id

messagesArray of objectsrequired

Thread messages

metadataobjectrequired

Thread metadata

no_store_reply_neededArray of objects

Thread "no store reply needed" actions.

topicobjectrequired

Thread topic

Response

{
  "authorized_participants": [
    { … },
    { … }
  ],
  "current_participants": [
    { … },
    { … }
  ],
  "customer_organization": {
    "display_name": "Customer organization",
    "id": "customer-org-id"
  },
  "date_created": "2018-10-02T08:36:36.479Z",
  "date_updated": "2018-10-03T09:40:17.241Z",
  "entities": [
    { … }
  ],
  "id": "702c3e56-dcca-41e2-b6bd-72ba3fa809be",
  "messages": [
    { … },
    { … }
  ],
  "metadata": {
    "last_message_date": "2018-10-03T09:40:17.241Z",
    "last_sender": { … },
    "shop_reply_needed_since": null,
    "total_count": 2
  },
  "no_store_reply_needed": [],
  "topic": {
    "type": "FREE_TEXT",
    "value": "Questions about my order"
  }
}