Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Inputs
/
RecipientInput

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

CreateThreadInput

attachments
[AttachmentInput!],non-null

Files to attach to the thread.

threadInput
ThreadDetailsInput!,non-null

New thread details.

Sample
{
  "attachments": [
    {
      "__typename": "AttachmentInput"
    }
  ],
  "threadInput": {
    "__typename": "ThreadDetailsInput"
  }
}

ThreadDetailsInput

body
String!,non-null

Body of the first message of the thread.

to
[String!]!,non-null

Message recipients. Valid values are: OPERATOR, SHOP, CUSTOMER

topic
TopicInput!,non-null

The topic can either have a free or a fixed value depending on the topic type

Sample
{
  "body": "Example String",
  "to": [
    "Example String"
  ],
  "topic": {
    "__typename": "TopicInput"
  }
}
Referenced in
CreateThreadInput.threadInput

TopicInput

type
String!,non-null

Must be FREE_TEXT or REASON_CODE

value
String!,non-null

If type is FREE_TEXT, a text. If type is REASON_CODE, a valid reason code.

Sample
{
  "type": "Example String",
  "value": "Example String"
}
Referenced in
ThreadDetailsInput.topic
ReplyToThreadInput.topic

AttachmentInput

name
String!,non-null

The name of the file.

url
Url!,non-null

The url of the file returned by the file upload api /api/graphql/upload

Sample
{
  "name": "Example String",
  "url": "Example Custom Scalar"
}
Referenced in
CreateThreadInput.attachments
ReplyToThreadInput.attachments

ReplyToThreadInput

attachments
[AttachmentInput!],non-null

Files to attach to the thread.

body
String!,non-null

Body of the message to add to the thread.

to
[RecipientInput!]!,non-null

Message recipients.

topic
TopicInput

New topic for the thread. Leave empty to keep the current topic.

Sample
{
  "attachments": [
    {
      "__typename": "AttachmentInput"
    }
  ],
  "body": "Example String",
  "to": [
    {
      "__typename": "RecipientInput"
    }
  ],
  "topic": {
    "__typename": "TopicInput"
  }
}

RecipientInput

id
ID
type
String!,non-null
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "type": "Example String"
}
Referenced in
ReplyToThreadInput.to

AdditionalFieldValueInput

booleanAdditionalFieldValue
BooleanAdditionalFieldValueInput
dateAdditionalFieldValueInput
DateAdditionalFieldValueInput
linkAdditionalFieldValue
LinkAdditionalFieldValueInput
stringListAdditionalFieldValue
StringListAdditionalFieldValueInput
multipleValuesStringListAdditionalFieldValue
MultipleValuesStringListAdditionalFieldValueInput
numericAdditionalFieldValue
NumericAdditionalFieldValueInput
regexFieldValue
RegexAdditionalFieldValueInput
stringAdditionalFieldValue
StringAdditionalFieldValueInput
textAreaAdditionalFieldValue
TextAreaAdditionalFieldValueInput
Sample
{
  "booleanAdditionalFieldValue": {
    "__typename": "BooleanAdditionalFieldValueInput"
  },
  "dateAdditionalFieldValueInput": {
    "__typename": "DateAdditionalFieldValueInput"
  },
  "linkAdditionalFieldValue": {
    "__typename": "LinkAdditionalFieldValueInput"
  },
  "stringListAdditionalFieldValue": {
    "__typename": "StringListAdditionalFieldValueInput"
  },
  "multipleValuesStringListAdditionalFieldValue": {
    "__typename": "MultipleValuesStringListAdditionalFieldValueInput"
  },
  "numericAdditionalFieldValue": {
    "__typename": "NumericAdditionalFieldValueInput"
  },
  "regexFieldValue": {
    "__typename": "RegexAdditionalFieldValueInput"
  },
  "stringAdditionalFieldValue": {
    "__typename": "StringAdditionalFieldValueInput"
  },
  "textAreaAdditionalFieldValue": {
    "__typename": "TextAreaAdditionalFieldValueInput"
  }
}
Referenced in
CreateOrdersInput.orderAdditionalFields
OrderOfferInput.orderLineAdditionalFields

BooleanAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{
  "code": "Example String",
  "value": "Example String"
}
Referenced in
AdditionalFieldValueInput.booleanAdditionalFieldValue

DateAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{
  "code": "Example String",
  "value": "Example String"
}
Referenced in
AdditionalFieldValueInput.dateAdditionalFieldValueInput

LinkAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{
  "code": "Example String",
  "value": "Example String"
}
Referenced in
AdditionalFieldValueInput.linkAdditionalFieldValue

StringListAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{
  "code": "Example String",
  "value": "Example String"
}
Referenced in
AdditionalFieldValueInput.stringListAdditionalFieldValue

Scalars

Overview