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": "f8e017adec83e95c34d2682b",
"orderRef": "301a91d7d8d9913050331227"
}
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. |