Skip to navigation
ActivitiesNotes

Update a Note activity

View as Markdown

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.
OR
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

Type of the activity, e.g. Call, Email or Note.

activity_atdatetime or null

When the activity happened, e.g. when an Email or SMS was sent. Defaults to date_created.

attachmentslist of objects
contact_idstring or null

ID of the Contact the activity is with, or null if it isn’t with a particular Contact.

created_bystring or null

ID of the user who created the activity, or null if it wasn’t created by a user.

date_createddatetime
When the activity was created.
date_updateddatetime
When the activity was last updated.
idstring

ID of the activity, e.g. acti_abc123.

lead_idstring or null

ID of the Lead the activity is on. Can be null for Calls and SMS with phone numbers that don’t match any Contact.

notestring
note_htmlstring
note_mentionslist of strings
organization_idstring
ID of the organization the activity belongs to.
pinnedboolean
pinned_atdatetime or null
sourceenum or null

How the object was created, e.g. ui in the Close app, api through the API, import by a bulk import, or by an integration.

titlestring or null
updated_bystring or null

ID of the user who last updated the activity, or null if it wasn’t updated by a user.

user_idstring or null

ID of the user the activity belongs to, e.g. who made the Call or sent the Email. Can be null, e.g. for an incoming SMS to a group number.

userslist of strings
IDs of all users the activity is associated with, e.g. every Close user on an Email Thread or invited to a Meeting.
agent_action_reasonstring or nullOptional

Why an agent created the activity, e.g. send_scheduling_link, or null if no agent created it.

comment_summaryobject or nullOptional
created_by_agent_idstring or nullOptional

ID of the agent that created the activity, or null if no agent created it.

created_by_namestring or nullOptional

Name of the user in created_by.

updated_by_agent_idstring or nullOptional

ID of the agent that last updated the activity, or null if the last update wasn’t made by an agent.

updated_by_namestring or nullOptional

Name of the user in updated_by.

user_namestring or nullOptional

Name of the user in user_id.

agent_config_idstring or nullOptionalDeprecated

Deprecated. Use created_by_agent_id instead.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error