Mutation
mutation CreateNote($input: CreateNoteInput!) {
createNote(input: $input) {
note {
id
text
markdown
customer {
id
externalId
fullName
shortName
email {
__typename
}
avatarUrl
}
attachments {
id
fileName
fileSize {
__typename
}
fileExtension
fileMimeType
type
}
externalId
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"customerId": "id",
"text": "string"
}
}Response
{
"data": {
"createNote": {
"note": {
"id": "id",
"text": "string",
"markdown": "string",
"customer": {
"id": "id",
"externalId": "id",
"fullName": "string",
"shortName": "string",
"email": {
"__typename": "EmailAddress"
},
"avatarUrl": "string"
},
"attachments": [
{
"id": "id",
"fileName": "string",
"fileSize": {
"__typename": "FileSize"
},
"fileExtension": "string",
"fileMimeType": "string",
"type": "EMAIL"
}
],
"externalId": "id"
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
createNote
Creates an internal note visible only to your team. Notes appear in the thread timeline
alongside customer messages and are useful for sharing context, reminders, or annotations.
Provide threadId to pin the note to a specific thread; omit it to attach the note to the
customer so it appears across all of their threads. Requires the note:create permission.
MUTATION
createNote(input: CreateNoteInput!): CreateNoteOutput!Arguments
input
required
Returns
note
error
Mutation
mutation CreateNote($input: CreateNoteInput!) {
createNote(input: $input) {
note {
id
text
markdown
customer {
id
externalId
fullName
shortName
email {
__typename
}
avatarUrl
}
attachments {
id
fileName
fileSize {
__typename
}
fileExtension
fileMimeType
type
}
externalId
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"customerId": "id",
"text": "string"
}
}Response
{
"data": {
"createNote": {
"note": {
"id": "id",
"text": "string",
"markdown": "string",
"customer": {
"id": "id",
"externalId": "id",
"fullName": "string",
"shortName": "string",
"email": {
"__typename": "EmailAddress"
},
"avatarUrl": "string"
},
"attachments": [
{
"id": "id",
"fileName": "string",
"fileSize": {
"__typename": "FileSize"
},
"fileExtension": "string",
"fileMimeType": "string",
"type": "EMAIL"
}
],
"externalId": "id"
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

