Skip to main content
POST
Create a note

Authorizations

Authorization
string
header
required

A Parley API key.

Body

application/json
name
string
required

The note title.

Required string length: 1 - 255
content
string
required

The note's markdown. Refer to a file with @name [blocked] and a folder with @name/ [blocked]: these render as links and survive renames. Keep existing references exactly as they are when editing.

projectId
string

Put the note on this project. Pass exactly one of projectId, accountId, or contactId.

Minimum string length: 1
accountId
string

Put the note on this account. Pass exactly one of projectId, accountId, or contactId.

Minimum string length: 1
contactId
string

Put the note on this contact. Pass exactly one of projectId, accountId, or contactId.

Minimum string length: 1

Response

Created.

id
string
required

The note ID.

Minimum string length: 1
name
string
required

The note title.

location
object
required

The project, account, or contact the note is on.

version
integer
required

Goes up by one each time the content changes or the note is renamed through the API. Pass it as expectedVersion when updating the note.

Required range: 1 <= x <= 9007199254740991
createdAt
string<date-time>
required

When the note was created.

updatedAt
string<date-time>
required

When the note was last changed, including renames.