Skip to main content
POST
/
api
/
notes
Create a note
curl --request POST \
  --url https://api.morphic.io/api/notes/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "body": "Discussed pricing. Will send proposal by Friday.",
  "entity_id": "550e8400-e29b-41d4-a716-446655440000",
  "entity_type": "contact",
  "pinned": false,
  "title": "Follow-up notes"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "entity_type": "<string>",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "body": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "pinned": false,
  "metadata": {},
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

X-API-Key
string
header
required

API key (sk_xxx) from Developer Settings. No X-Account-ID needed.

Headers

x-account-id
string | null

Body

application/json
entity_type
string
required

Entity type this note references (company, contact, deal, activity).

entity_id
string<uuid>
required

Primary entity identifier the note is attached to.

body
string
required
Minimum string length: 1
title
string | null
Maximum string length: 255
pinned
boolean
default:false
metadata
Metadata · object

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
entity_type
string
required

Entity type this note references (company, contact, deal, activity).

entity_id
string<uuid>
required

Primary entity identifier the note is attached to.

body
string
required
Minimum string length: 1
account_id
string<uuid>
required
title
string | null
Maximum string length: 255
pinned
boolean
default:false
metadata
Metadata · object
created_by
string<uuid> | null