NOTE

Adds a new note.

POST/api/v2/notes

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Request body

application/jsonrequired

The details of the note to add.

noteTypestring
companyIdinteger · int32
taskIdinteger · int32nullable
recordIdinteger · int32
recordTypestring
typeIdinteger · int32required
noteDatestring · daterequired
commentsstringrequired
contactsinteger[]
notePurposesinteger[]
noteResultsinteger[]

Responses

Note added successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

noteIdinteger · int32
companyIdinteger · int32
companyNamestringnullable
noteTypestring
recordIdinteger · int32
recordTypestring
relatedTostring
ownerstring
userIdinteger · int32
typeIdinteger · int32
noteDatestring · date
commentsstring
enterBystring
lastModifiedBystring
lastModifiedstring · date-timenullable
enteredstring · date-timenullable
deletedboolean
contactsinteger[]
notePurposesinteger[]
noteResultsinteger[]
notePurposeDisplaysstring[]
noteResultDisplaysstring[]
noteContactDisplaysstring[]

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/notes' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "noteType": "string",
    "companyId": 1024,
    "taskId": 1024,
    "recordId": 1024,
    "recordType": "string",
    "typeId": 1024,
    "noteDate": "2026-01-15",
    "comments": "string",
    "contacts": [
      1
    ],
    "notePurposes": [
      1
    ],
    "noteResults": [
      1
    ],
    "udfs": [
      {
        "fieldName": "string",
        "fieldValue": "string",
        "recordType": "string"
      }
    ]
  }'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "noteId": 1024,
    "companyId": 1024,
    "companyName": "Acme Equipment Co.",
    "noteType": "string",
    "recordId": 1024,
    "recordType": "string",
    "relatedTo": "string",
    "owner": "string",
    "userId": 1024,
    "typeId": 1024,
    "noteDate": "2026-01-15",
    "comments": "string",
    "enterBy": "string",
    "lastModifiedBy": "string",
    "lastModified": "2026-01-15T14:30:00Z",
    "entered": "2026-01-15T14:30:00Z",
    "deleted": false,
    "contacts": [
      1
    ],
    "notePurposes": [
      1
    ],
    "noteResults": [
      1
    ],
    "notePurposeDisplays": [
      "string"
    ],
    "noteResultDisplays": [
      "string"
    ],
    "noteContactDisplays": [
      "string"
    ],
    "udfs": [
      {
        "udf": {
          "udfid": 1024,
          "recordType": "string",
          "categoryId": 1024,
          "subCategoryId": 1024,
          "category": "string",
          "categorySortOrder": 1,
          "subCategory": "string",
          "subCategorySortOrder": 1,
          "fieldName": "string",
          "displayText": "string",
          "dataType": "string",
          "editable": true,
          "visible": true,
          "required": true,
          "complete": true,
          "editCriteria": "string",
          "editRules": "string",
          "sortOrder": 1,
          "location": "string",
          "lastModified": "2026-01-15T14:30:00Z",
          "deleted": false
        },
        "lookups": [
          {
            "udflookupId": 1024,
            "udfid": 1024,
            "value": "string",
            "groupName": "string",
            "sortOrder": 1,
            "lastModified": "2026-01-15T14:30:00Z",
            "deleted": false
          }
        ],
        "assignedId": 1024,
        "udfid": 1024,
        "recordType": "string",
        "recordId": 1024,
        "lookupId": 1024,
        "stringValue": "string",
        "dateValue": "2026-01-15",
        "numericValue": 125000.5,
        "booleanValue": true,
        "entered": "2026-01-15T14:30:00Z",
        "lastModified": "2026-01-15T14:30:00Z"
      }
    ],
    "recordAccessRights": {
      "exists": true,
      "view": true,
      "edit": true,
      "delete": true,
      "addNote": true
    }
  },
  "errors": []
}