Create an activity

Creates an activity. See side effects for calendar sync, reminders and automations.

Endpoint

POST
/activities

Body

NameTypeRequiredDescription
organization_idintegerYesOrganization to create the activity in.
subjectstringYesTitle.
activity_typestringNoDefault call. Built-in types: call, meeting, task, deadline, email, lunch.
assigned_to_user_idintegerNoAssignee.
start_datestringNoYYYY-MM-DD.
start_timestringNoHH:MM, 24 h.
end_datestringNoYYYY-MM-DD.
end_timestringNoHH:MM, 24 h.
durationnumberNoMinutes.
deal_idintegerNoLinked deal.
contact_idintegerNoLinked contact.
company_idintegerNoLinked company.
notestringNoInternal notes.
public_descriptionstringNoDescription for the calendar event.
locationstringNoLocation.
donebooleanNoDefault false.
attendeesarrayNo{ email, name, responseStatus } items invited to the synced event.
create_google_meetbooleanNoAdd a Google Meet link to the synced Google Calendar event.

Fields not in the activity object are rejected. created_by_user_id is set to the API key's user.

Request

Response

Returns the created activity object with linked records embedded.

json

Calendar sync runs right after the activity is saved, so the response can show the state before the sync finished. Get the activity again to read sync_status and google_meet_link.

Report an issue with this documentation

Please log in to report issues with our documentation.