Mutations
deleteNote
Soft-deletes a note. The note is marked as deleted but its record is retained. Requires the note:delete permission.
MUTATION
deleteNote(input: DeleteNoteInput!): DeleteNoteOutput!Arguments
input
required
Returns
note
error
Mutation
mutation DeleteNote($input: DeleteNoteInput!) {
deleteNote(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": {
"noteId": "id"
}
}Response
{
"data": {
"deleteNote": {
"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?
⌘I
Mutation
mutation DeleteNote($input: DeleteNoteInput!) {
deleteNote(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": {
"noteId": "id"
}
}Response
{
"data": {
"deleteNote": {
"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"
}
]
}
}
}
}
