Create a note

Create a new note for a specific resource.

POST /notes

Create a note

cURL

curl --request POST \
  --url https://{your-subdomain}.neetocrm.com/api/external/v1/notes \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "note": {
    "content": "Important note about Eve"
  },
  "resource_type": "contacts",
  "resource_id": 1
}
'

201

{
  "note": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "content": "Important note about Eve",
    "user_id": "u1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2025-03-15T10:30:00.000Z",
    "updated_at": "2025-03-15T10:30:00.000Z"
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json

note · object · required

Hide child attributes

note. content · string · required

Note content.

Example:

"Important note about Eve"

resource_type · enum<string> · required

Type of resource to attach the note to.

Available options: contacts, companies, deals, leads

Example:

"contacts"

resource_id · integer · required

ID of the resource.

Example:

1

Response

201 - application/json

Note created successfully.

note · object

Hide child attributes

note. id · string

Unique identifier for the note.

note. content · string

Content of the note.

note. user_id · string

Unique identifier of the user who created the note.

note. created_at · string<date-time>

Timestamp when the note was created.

note. updated_at · string<date-time>

Timestamp when the note was last updated.