Create a note

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

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body

entityType NoteEntityType required

Possible values: [contact, job, stockItem, resource, vehicle, salesOpportunity, contract]

The type of entity that the note is associated to

Possible values:

• contact: Associated with a contact entity
• job: Associated with a job entity
• stockItem: Associated with a stock item entity
• resource: Associated with a resource entity
• vehicle: Associated with a vehicle entity
• salesOpportunity: Associated with a sales opportunity entity
• contract: Associated with a contract entity

entityId int64 required

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

typeId int64 required

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

subject string required

Possible values: non-empty

The subject of the note

ownedByUserId int64 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

parentId int64 nullable

The unique identifier of the parent note of this note

dueAt date-time nullable

The UTC timestamp of when this note is due for completion

reference string nullable

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

status NoteStatus

Possible values: [open, completed, cancelled]

The status of the note

Possible values:

• open: Open
• completed: Completed
• cancelled: Cancelled

completionText string nullable

The completion text for the note

description string

The detailed textual content about the note

customFields object[] nullable
Custom fields associated with the contact
Array [
definitionId int64 required
The unique identifier of the associated custom field definition
value string nullable
The value of this custom field. If set to null, any existing value will be unset
]

Responses

• 201
• 400
• 403
• 422
• 500

---

Created

application/json

Schema

Example (from schema)

---

Schema

id int64

Identifier of the newly created record

{
  "id": 0
}

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

errors object
property name* string[]
Array [
string
]
type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "errors": {},
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...