Create load note

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Create a new note associated with a specific load.

Notes can be used to store operational comments, updates, or other annotations related to the load.

Path Parameters

NameTypeRequiredDescription
loadNumberstringYesThe unique number identifying the load.
versionstringYesAPI version (e.g., 2.0). Default value: 2.0.

Request Body

{
  "Id": "string",
  "Description": "string",
  "NoteType": "string"
}

Request Body Parameters

NameTypeRequiredDescription
IdstringYesUnique identifier of the note.
DescriptionstringYesThe text content of the note. Maximum 4000 characters.
NoteTypestringYesThe category or type of the note. Maximum 50 characters. Must be one of: System, General, Assignment, Safety.

Responses

201 Created

Returned when a new note is successfully created.

{
  "CreatedAt": "2026-03-16T12:54:26.203Z",
  "CreatedBy": "string",
  "CreatedById": "string",
  "Description": "string",
  "Id": "string",
  "NoteType": "string"
}
Path Params
string
required
string
required
Defaults to 2.0

API version (e.g., 2.0)

Body Params
string
required
string
required
string
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json