Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Notes

Create a note

Creates a new note associated with a specific entity (required scope notes:write)

post/v1/notes

Headers

Customer-Idinteger required

The customer identifier

Request body

entityType'contact' | 'job' | 'stockItem' | 'resource' | 'vehicle' | 'salesOpportunity' | 'contract' required

The type of entity that the note is associated to<p>Possible values:</p><ul><li><b>contact</b>: Associated with a contact entity</li><li><b>job</b>: Associated with a job entity</li><li><b>stockItem</b>: Associated with a stock item entity</li><li><b>resource</b>: Associated with a resource entity</li><li><b>vehicle</b>: Associated with a vehicle entity</li><li><b>salesOpportunity</b>: Associated with a sales opportunity entity</li><li><b>contract</b>: Associated with a contract entity</li></ul>

entityIdinteger required

The unique identifier of the associated entity that owns the note, relative to the entityType

typeIdinteger required

The unique identifier of the note type definition associated to this note

subjectstring required

The subject of the note

ownedByUserIdinteger nullable

The unique id of the user who owns the note. Must have an active licence. If not provided, this will be set to the default user in the note type or the user ID of the API request

parentIdinteger nullable

The unique identifier of the parent note of this note

dueAtstring date-time nullable

The UTC timestamp of when this note is due for completion

referencestring nullable

The internal reference of the note - should usually be unique. If not provided, this will be auto-generated

status'open' | 'completed' | 'cancelled'

The status of the note<p>Possible values:</p><ul><li><b>open</b>: Open</li><li><b>completed</b>: Completed</li><li><b>cancelled</b>: Cancelled</li></ul>

completionTextstring nullable

The completion text for the note

descriptionstring nullable

The detailed textual content about the note

Example request

{
  "entityType": "contact",
  "entityId": 5514123,
  "typeId": 5514123,
  "subject": "Call Mr Brown",
  "ownedByUserId": 67246,
  "parentId": 5514123,
  "dueAt": "2022-11-29T16:50:16.0000000+00:00",
  "reference": "5514123",
  "status": "open",
  "completionText": "Completed",
  "description": "Message left by Mr Brown regarding the recent installation of his CCTC cameras. He can't get one of them working and needs some technical support.",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

Created

idinteger

Identifier of the newly created record