Daylite WebsiteMarketcircle Blog
API Reference

Note

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

Modify a note

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

See Note for the attributes. Attributes you leave out are not changed. Lists such as keywords and contacts accept {"add": [...], "remove": [...]} to change only some entries, e.g. {"contacts": {"add": [{"contact": "/v1/contacts/1000"}]}}.

A note in the trash can't be edited (404 with {"error":"trashed_object"}) until you restore it with {"trashed": false}. A successful update returns 204 No Content.

Path Params
int32
required

The note ID

Body Params
string

Title (max 512 characters).

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

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

appointments

Appointments linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

contacts

Contacts linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

Companies linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

Opportunities linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

Projects linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

Tasks linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

Groups linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

Forms linked to the note. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

email_messages

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

string

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

boolean

Set to false to restore the note from the trash. Use DELETE to move it to the trash.

Responses
204

204 No Content

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