noteCreate Mutation

Adds a new note to a record.

• Input Argument
• Return Fields

Input Argument

noteCreate accepts a single input argument, an input type , which contains the values it uses.

The fields inside input are:

attachments ( AttachmentInput )

The attachments used in the note field.

clientMutationId ( String )

A unique identifier for the client performing the mutation.

internal ( Boolean )

Whether the note should be visible only for people who have the Auditor, Specialist or Account Administrator role of the account. Internal notes are only available for Requests.

ownerId ( ID )

The record that the note should be added to.

suppressNoteAddedNotifications ( Boolean )

Whether Note Added notifications for this note should be suppressed.

text ( String! )

Text of the note.

Return Fields

clientMutationId ( String )

A unique identifier for the client performing the mutation.

errors ( ValidationError )

Errors encountered during the mutation.

note ( Note )

Record after mutation.

Examples

Create a note with rich text formatting

The text field supports rich text formatting, including bold, italic, lists, code blocks, and expandable sections. The ownerId must be a GraphQL node ID.

mutation {
  noteCreate(input: {
    ownerId: "cnJ0MS4yNTA5MTUxMzM2MTlAZGVtby5yLXNlcnZpY2UudGVjaC9SZXEvMTIzNDU="
    text: "Please verify the following:\n\n* Check **error logs** for the past 24 hours\n* Verify __network connectivity__\n* Monitor `system resources`"
  }) {
    note {
      id
      text
    }
    errors {
      path
      message
    }
  }
}

Create a note with an expandable section (spoiler)

mutation {
  noteCreate(input: {
    ownerId: "cnJ0MS4yNTA5MTUxMzM2MTlAZGVtby5yLXNlcnZpY2UudGVjaC9SZXEvMTIzNDU="
    text: "<details>\n<summary>Diagnostic Information</summary>\n\nPlease review:\n\n* **Log file**: /var/log/system.log\n* **Status**: Check with `systemctl status service`\n\n</details>"
  }) {
    note {
      id
      text
    }
    errors {
      path
      message
    }
  }
}

Note: The token must have the note:Read scope if requesting the note object in the response.

Create an internal note with expandable sections

mutation {
  noteCreate(input: {
    ownerId: "cnJ0MS4yNTA5MTUxMzM2MTlAZGVtby5yLXNlcnZpY2UudGVjaC9SZXEvMTIzNDU="
    text: "<details>\n<summary>Internal Diagnosis</summary>\n\nThis is internal information only for specialists.\n\n</details>"
    internal: true
  }) {
    errors {
      path
      message
    }
  }
}

Create a note with multiple expandable sections

mutation {
  noteCreate(input: {
    ownerId: "cnJ0MS4yNTA5MTUxMzM2MTlAZGVtby5yLXNlcnZpY2UudGVjaC9SZXEvMTIzNDU="
    text: "<details>\n<summary>Section 1</summary>\n\nContent for the first section.\n\n</details>\n\n<details>\n<summary>Section 2</summary>\n\nContent for the second section.\n\n</details>"
  }) {
    note {
      id
    }
  }
}

Required permissions

To create a note on a request, the token must have:

• request:Update - to create the note
• note:Read - additionally required if requesting the note object in the response