Products

Mirakl Platform

GraphQL Reference

ThreadMessage

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ThreadEdge

An edge in a connection.

node

Thread!,non-null

The item of the edge.

Sample

{
  "node": {
    "authorizedParticipants": [
      {
        "__typename": "ThreadParticipant"
      }
    ],
    "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "currentParticipants": [
      {
        "__typename": "ThreadParticipant"
      }
    ],
    "customerOrganization": {
      "__typename": "ThreadCustomerOrganization"
    },
    "dateCreated": "Example Custom Scalar",
    "entities": [
      {
        "__typename": "ThreadEntity"
      }
    ],
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "messages": [
      {
        "__typename": "ThreadMessage"
      }
    ],
    "metadata": {
      "__typename": "ThreadMetadata"
    },
    "topic": {
      "__typename": "ThreadTopic"
    }
  }
}

Referenced in

ThreadConnection.edges

Thread

Represents a thread.

authorizedParticipants

[ThreadParticipant!]!,non-null

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

businessId

ID!,non-null

currentParticipants

[ThreadParticipant!]!,non-null

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.

customerOrganization

ThreadCustomerOrganization

Data related to the customer organization (B2B transactions)

dateCreated

DateTime!,non-null

Thread creation date

entities

[ThreadEntity!],non-null

Thread entities

ID!,non-null

Thread id

messages

[ThreadMessage]!,non-null

Thread messages

metadata

ThreadMetadata

Thread metadata

topic

ThreadTopic!,non-null

Thread topic

Implements interfaces

Node

Sample

{
  "authorizedParticipants": [
    {
      "__typename": "ThreadParticipant"
    }
  ],
  "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "currentParticipants": [
    {
      "__typename": "ThreadParticipant"
    }
  ],
  "customerOrganization": {
    "__typename": "ThreadCustomerOrganization"
  },
  "dateCreated": "Example Custom Scalar",
  "entities": [
    {
      "__typename": "ThreadEntity"
    }
  ],
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "messages": [
    {
      "__typename": "ThreadMessage"
    }
  ],
  "metadata": {
    "__typename": "ThreadMetadata"
  },
  "topic": {
    "__typename": "ThreadTopic"
  }
}

Referenced in

CreateThreadResponse.thread

ReplyToThreadResponse.thread

ThreadEdge.node

ThreadParticipant

Represents a thread participant.

displayName

String!,non-null

Participant display name

Participant id. When type equals OPERATOR, no id will be returned.

type

String!,non-null

Participant type. Possible values are: CUSTOMER, OPERATOR, SHOP

Sample

{
  "displayName": "Example String",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "type": "Example String"
}

Referenced in

Thread.authorizedParticipants

Thread.currentParticipants

ThreadCustomerOrganization

Represents a customer organization.

displayName

String!,non-null

Customer organization name

ID!,non-null

Customer organization id

Sample

{
  "displayName": "Example String",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

Referenced in

Thread.customerOrganization

ThreadEntity

Represents an entity link to a thread such as an order, an offer...

ID!,non-null

Entity id

label

String!,non-null

Entity label

type

String!,non-null

Entity type. Possible values are: MMP_ORDER, MMP_OFFER, MPS_ORDER, MPS_SERVICE

Sample

{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "label": "Example String",
  "type": "Example String"
}

Referenced in

Thread.entities

ThreadMessage

Represents a message in a thread.

attachments

[ThreadMessageAttachment!]!,non-null

Message attachments

body

String!,non-null

Message body

dateCreated

DateTime!,non-null

Message creation date

from

ThreadMessageSender!,non-null

Message sender

ID!,non-null

Message id

[ThreadMessageRecipient!]!,non-null

Message recipients

Sample

{
  "attachments": [
    {
      "__typename": "ThreadMessageAttachment"
    }
  ],
  "body": "Example String",
  "dateCreated": "Example Custom Scalar",
  "from": {
    "__typename": "ThreadMessageSender"
  },
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "to": [
    {
      "__typename": "ThreadMessageRecipient"
    }
  ]
}

Referenced in

Thread.messages

ThreadMessageAttachment

Represents an attachment in a message.

ID!,non-null

Attachment id

name

String!,non-null

Attachment file name

size

Long!,non-null

Attachment size

downloadUrl

Url!,non-null

Attachment download url to retrieve the file

Sample

{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String",
  "size": "Example Custom Scalar",
  "downloadUrl": "Example Custom Scalar"
}

Referenced in

ThreadMessage.attachments

ThreadMessageSender

Represents the sender of a message.

displayName

String!,non-null

Sender display name

organizationDetails

ThreadMessageSenderOrganization

Organization details of the sender

type

String!,non-null

Sender type. Possible values are: CUSTOMER, OPERATOR, SHOP

Sample

{
  "displayName": "Example String",
  "organizationDetails": {
    "__typename": "ThreadMessageSenderOrganization"
  },
  "type": "Example String"
}

Referenced in

ThreadMessage.from

ThreadMetadata.lastSender

ThreadMessageSenderOrganization

Represents the organization details of the sender.

displayName

String!,non-null

Organization display name

String

Organization id. When type equals OPERATOR, no id will be returned.

type

String!,non-null

Organization type. Possible values are: CUSTOMER, OPERATOR, SHOP.

Sample

{
  "displayName": "Example String",
  "id": "Example String",
  "type": "Example String"
}

Referenced in

ThreadMessageSender.organizationDetails

ThreadMessageRecipient

Represents a recipient of a message.

displayName

String!,non-null

Recipient display name

String

Recipient id. When type equals OPERATOR, no id will be returned.

type

String!,non-null

Recipient type. Possible values are: CUSTOMER, OPERATOR, SHOP.

Sample

{
  "displayName": "Example String",
  "id": "Example String",
  "type": "Example String"
}

Referenced in

ThreadMessage.to

ThreadMetadata

Represents a thread's metadata.

lastMessageDate

DateTime!,non-null

Date of the last message

lastSender

ThreadMessageSender!,non-null

Last message sender

totalCount

Int!,non-null

Number of messages in the thread

Sample

{
  "lastMessageDate": "Example Custom Scalar",
  "lastSender": {
    "__typename": "ThreadMessageSender"
  },
  "totalCount": 40
}

Referenced in

Thread.metadata

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview