Skip to main content
POST
/
v1
/
notes
Create note
curl --request POST \
  --url https://api.octolane.com/v1/notes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "note": {
    "title": "<string>",
    "content": "<string>"
  },
  "account_domains": [
    "<string>"
  ],
  "contact_emails": [
    "jsmith@example.com"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "data": "<unknown>"
}

Authorizations

x-api-key
string
header
required

Public API key for the Octolane organization.

Body

application/json

Note payload.

note
object
required
account_domains
string[] | null
contact_emails
string<email>[] | null

Response

Note was created.

success
boolean
Example:

true

message
string
data
any

Endpoint-specific response payload.