Skip to content

Send a Return Message

About

The createCustomerReturnMessage mutation adds a customer message to the conversation thread of a return (RMA) request. The return must belong to the authenticated customer. The created message comes back flagged isAdmin: false.

Authentication

This mutation requires an authenticated customer — send the storefront key and a customer Bearer token. See the Authentication page.

Input Fields

FieldTypeRequiredDescription
returnIdInt!✅ YesId of the return to add the message to. Must belong to the authenticated customer.
messageString!✅ YesThe message text.

Possible Returns

FieldTypeDescription
customerReturnMessage._idInt!Numeric message id.
customerReturnMessage.rmaIdInt!Id of the return the message belongs to.
customerReturnMessage.messageString!The message text.
customerReturnMessage.isAdminBoolean!false — the message was sent by the customer.
customerReturnMessage.attachmentStringStored attachment path, or null.
customerReturnMessage.attachmentUrlStringPublic URL of the attachment, or null.
customerReturnMessage.createdAtDateTime!Message timestamp.

File attachments

Attaching a file to a message is available over REST only, via a multipart file field — files cannot be transported over a JSON GraphQL request.

Released under the MIT License.