messageThreadArchive Mutation

Description

Archives every message in a conversation, resolved the same way as the messages query. Returns how many were archived. Nothing is deleted — see messageArchive.

mutation messageThreadArchive($threadKey: ID!, $orderRef: ID) {
  messageThreadArchive(threadKey: $threadKey, orderRef: $orderRef)
}

Variables

{
    "threadKey": "17d64f8cf555c2b938dc46af",
    "orderRef": "b310d2a324e187a7e7b5e1d4"
}

Response

{
    "messageThreadArchive": "example"
}

Arguments

Name	Type	Description
threadKey	ID!	Key of the conversation, from the messageThreads query.
orderRef	ID	Order reference of the conversation when it has one. Takes precedence over threadKey.

Returns

String!