Skip to main content
String!
required
The note as plain text: 1 to 10,000 characters, and not only whitespace. HTML isn’t interpreted.
String
A key you choose, up to 100 characters. A retry with the same key on the same thread returns the first note and adds nothing. Once that note is deleted, the key throws BAD_USER_INPUT.
[ID!]
TeamMember ids to notify, at most 20 different ones; a repeated id counts once. Each must be on the store’s team. They get the same in-app, email and push notice as an @mention in the help desk, following their notification settings.
ID!
required
The thread to attach it to. It must be one of the ticket’s threads.
Boolean
Whether the AI agent can read this note when it writes replies on the ticket. Defaults to true, as in the help desk.