Create an activity
Creates an activity. See side effects for calendar sync, reminders and automations.
Endpoint
POST/activities
Body
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Organization to create the activity in. |
subject | string | Yes | Title. |
activity_type | string | No | Default call. Built-in types: call, meeting, task, deadline, email, lunch. |
assigned_to_user_id | integer | No | Assignee. |
start_date | string | No | YYYY-MM-DD. |
start_time | string | No | HH:MM, 24 h. |
end_date | string | No | YYYY-MM-DD. |
end_time | string | No | HH:MM, 24 h. |
duration | number | No | Minutes. |
deal_id | integer | No | Linked deal. |
contact_id | integer | No | Linked contact. |
company_id | integer | No | Linked company. |
note | string | No | Internal notes. |
public_description | string | No | Description for the calendar event. |
location | string | No | Location. |
done | boolean | No | Default false. |
attendees | array | No | { email, name, responseStatus } items invited to the synced event. |
create_google_meet | boolean | No | Add 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.