Daylite WebsiteMarketcircle Blog
API Reference

Note

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

Create a note.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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


title defaults to "Untitled Note". details is plain text; see Details.

{
  "title": "How to bake a cake",
  "details": "Step 1: Preheat the oven.\nStep 2: Mix the batter.",
  "category": "Recipes",
  "contacts": [{ "contact": "/v1/contacts/1000" }]
}

A successful request returns 201 Created with the new note's reference, e.g. {"location": "/v1/notes/4000"}.

Body Params
string

Title (max 512 characters). Defaults to Untitled Note.

string

The text of the note, as plain text. Send "" to clear it; null is rejected.

string

Category name. Created if it does not exist. Send null or "" to clear.

keywords
array of strings

List of keyword names (max 64). Keywords that do not exist are created. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

keywords
appointments
array of objects

Appointments linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

appointments
contacts
array of objects

Contacts linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

contacts
companies
array of objects

Companies linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

companies
opportunities
array of objects

Opportunities linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

opportunities
projects
array of objects

Projects linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

projects
tasks
array of objects

Tasks linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

tasks
groups
array of objects

Groups linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

groups
forms
array of objects

Forms linked to the note. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

forms
email_messages
array of objects

Emails to link to the note. Write-only: use GET /v1/notes/{id}/emails to list them. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

email_messages
string

Reference to the user responsible for the note, e.g. /v1/users/1000. Defaults to the user making the request.

Responses

Updated 7 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago