Update a Note activity | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/activity/note/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "note_html": "<body><p>this is an update to my existing note.</p></body>",
  "pinned": true
}'

{
  "_type": "Note",
  "activity_at": "2013-02-20T06:39:57.266000+00:00",
  "contact_id": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-20T06:39:57.266000+00:00",
  "date_updated": "2013-02-20T06:41:59.846000+00:00",
  "id": "acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw",
  "lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": "Bruce Wayne",
  "updated_by_name": "Bruce Wayne",
  "user_name": "Bruce Wayne",
  "note": "this is an update to my existing note.",
  "note_html": "<body><p>this is an update to my existing note.</p></body>",
  "pinned": true,
  "pinned_at": "2013-02-20T06:41:59.846000+00:00",
  "title": "Welcome to Close!"
}

note_html and note: setting one overwrites the other. If both are provided, note_html takes precedence. note_html supports rich-text HTML; note is plaintext only.

A note can be pinned or unpinned by setting pinned to true or false.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

activity_atdatetime or nullOptional

attachmentslist of objects or nullOptional

contact_idstring or nullOptional

notestring or nullOptional

note_htmlstring or nullOptional

pinnedboolean or nullOptional

titlestring or nullOptional

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

created_bystring or null

date_createddatetime

date_updateddatetime

idstring

lead_idstring or null

organization_idstring

updated_bystring or null

user_idstring or null

userslist of strings

created_by_namestring or null

updated_by_namestring or null

user_namestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error