Skip to main content

messageArchive Mutation

Description​

Archives a message. The message is kept but no longer appears in the messages or messageThreads queries. Marketplace messages stay archived across a resync rather than being recreated.

mutation messageArchive($messageRef: ID!) {
messageArchive(messageRef: $messageRef)
}

Variables​

{
"messageRef": "60b391ecd02a4b244bc5b9ab"
}

Response​

{
"messageArchive": "example"
}

Arguments​

NameTypeDescription
messageRefID!Reference ID of the message to archive.

Returns​

String!