Activities

An activity is a task, call, meeting or other to-do on your calendar, optionally linked to a deal, contact or company and assigned to a user. When the assigned user has a connected Google or Outlook calendar that syncs the activity's type, the activity is also created on that calendar.

Endpoints

MethodPathDescription
GET/activitiesList activities
GET/activities/:idGet an activity
POST/activitiesCreate an activity
PATCH/activities/:idUpdate an activity
DELETE/activities/:idDelete an activity

Reads are limited to your API key's organization. Pass organization_id as a filter to work with one organization.

The activity object

json

company, assignedTo, createdBy, deal and contact are embedded on get, create and update responses, and on list when you pass fastJoinForActivityList=true.

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization that owns the activity. Required on create.
created_by_user_idinteger | nullRead-only. User who created the activity (the API key's user).
assigned_to_user_idinteger | nullUser the activity is assigned to. Calendar sync and reminders use this user.
subjectstringTitle. Required on create.
notestring | nullInternal notes.
public_descriptionstring | nullDescription shown on the synced calendar event.
locationstring | nullFree-text location.
location_geocodedobject | nullAny JSON describing the geocoded location.
start_datestring (date)Start date, YYYY-MM-DD.
start_timestringStart time. Send HH:MM (24 h); returned as HH:MM:SS. Times are in the organization's timezone.
end_datestring (date)End date, YYYY-MM-DD.
end_timestringEnd time. Send HH:MM (24 h); returned as HH:MM:SS.
durationnumberDuration in minutes.
deal_idinteger | nullLinked deal.
contact_idinteger | nullLinked contact.
company_idinteger | nullLinked company.
activity_typestringType of activity. Default call. The built-in types are call, meeting, task, deadline, email and lunch; see also Activity types.
donebooleanWhether the activity is completed. Default false.
attendeesarray | nullPeople invited to the synced calendar event: { email, name, responseStatus }. email is required; responseStatus is one of needsAction, accepted, declined, tentative.
create_google_meetboolean | nullSet to true to add a Google Meet link to the synced Google Calendar event.
google_meet_linkstring | nullRead-only. Google Meet link of the synced event.
synced_to_calendarbooleanRead-only. Whether the activity is on the assignee's external calendar. Default false.
sync_statusstring | nullRead-only. pending, synced, failed or not_synced.
last_synced_atstring (date-time) | nullRead-only. Last calendar sync time.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the activity is deleted.

Side effects

  • Create and update sync the activity to the assignee's connected calendar when their calendar integration syncs this activity_type and the activity is not done. Sync errors do not fail the request; they set sync_status to failed.
  • When assigned_to_user_id, start_date and start_time are set and the start is in the future, the assignee gets a reminder 10 minutes before the start.
  • Create and update trigger the organization's activity automations.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.