v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

contacts

Create Contact Note

Creates a new note entry associated with a specific contact.

Required Fields:

note: The body text of the note (max 1000 characters).

Behavior:

Returns 201 with empty body.
Returns 400 if required fields are missing or fail validation constraints.
Returns 401 if the caller is not authenticated.
Returns 404 if the contactId does not exist.

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

post/contacts/{contactId}/notes

Path parameters

contactIdstring uuid required

The contact's unique identifier

Request body

idstring uuid

The note's unique ID.

_linkstring

Use this URI to perform GET operations on the individual note resource. This link follows the pattern: /v2/contacts/{contactId}/notes/{noteId}

notestring required

A text with the note.

createdDatestring date-time

The DateTime when the note was created. An ISO 8601 string of datetime including the time component and ending with 'Z' (so in UTC). https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)

updatedDatestring date-time

The DateTime when the note was updated. An ISO 8601 string of datetime including the time component and ending with 'Z' (so in UTC). https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)

Example request

{
  "id": "cf3987e6-24bc-4b34-91bb-e230cd4ea6d7",
  "_link": "https://api.acculynx.com/v2/contacts/61370abe-3534-4ba8-b2f2-2ff56cdd5e02/notes/cf3987e6-24bc-4b34-91bb-e230cd4ea6d7",
  "note": "Text from the note.",
  "createdDate": "2026-03-25T09:30:00Z",
  "createdBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "updatedDate": "2026-03-26T09:30:00Z",
  "updatedBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  }
}

Response

Created