Note

post

https://api.marketcircle.net/v1/notes

Create a note.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Note for a list of attributes which are supported for notes. Only attributes marked as Read-Write can be set using this endpoint.

🚧
Details Encoding
The API currently does nothing to ensure the validity of details when creating a note. Until we decide on a proper encoding, the onus is on the client to submit valid data.
The desktop and mobile apps are happy with RTF encoded strings, but plain text will also work. Other encodings may partially work, but will most likely not be rendered correctly.
The API currently only supports plain text when creating or editing note details.

Body Params

title

string

Subject line of the note, suitable for indexing and later search/display

details

string

Contents of the note.

category

string

Category name

keywords

array of strings

List of Keywords

keywords

owner

string

URL of the User that is responsible for the note

appointments

array of objects

List of Appointments Example: /v1/appointments/1001

appointments

companies

array of objects

List of Companies Example: /v1/companies/1001

companies

contacts

array of objects

List of Contacts Example: /v1/contacts/1001

contacts

groups

array of objects

List of Groups Example: /v1/groups/1001

groups

opportunities

array of objects

List of Opportunities Example: /v1/opportunities/1001

opportunities

projects

array of objects

List of Projects Example: /v1/projects/1001

projects

tasks

array of objects

List of Tasks Example: /v1/tasks/1001

tasks

forms

array of objects

List of Forms Example: /v1/forms/1001

forms

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Details Encoding

204204

400400