Skip to content

Create Company Note

POST
/companies/{company_id}/notes

Create a note on a company.

Authorizations

Parameters

Path Parameters

company_id
required

Company ID (mashup_companies.id)

integer

Company ID (mashup_companies.id)

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
content
required

Note content (plain text or markdown)

string

Responses

201

Successful Response

object
data
required
object
content
required
string
created_at
Any of:
string
created_by
Any of:
string
created_by_name
Any of:
string
entity_id
required
string
entity_type
required
string
id
required
string
read_only
boolean
updated_at
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string