Skip to main content
POST
Create an activity

Authorizations

X-API-Key
string
header
required

API key (sk_xxx) from Developer Settings. No X-Account-ID needed.

Headers

x-account-id
string | null

Body

application/json
type
string
required

Activity type (email, meeting, call, note, task, stage_change, etc.)

subject
string | null
Maximum string length: 255
description
string | null
priority
string | null
status
string | null
duration_minutes
integer | null
Required range: x >= 0
due_date
string<date-time> | null
completed_at
string<date-time> | null
outcome
string | null
entity_type
string | null

Primary entity type this activity is linked to

entity_id
string<uuid> | null

Primary entity ID this activity is linked to

contact_id
string<uuid> | null
company_id
string<uuid> | null
deal_id
string<uuid> | null
metadata
Metadata · object

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
type
string
required

Activity type (email, meeting, call, note, task, stage_change, etc.)

account_id
string<uuid>
required
subject
string | null
Maximum string length: 255
description
string | null
priority
string | null
status
string | null
duration_minutes
integer | null
Required range: x >= 0
due_date
string<date-time> | null
completed_at
string<date-time> | null
outcome
string | null
entity_type
string | null

Primary entity type this activity is linked to

entity_id
string<uuid> | null

Primary entity ID this activity is linked to

contact_id
string<uuid> | null
company_id
string<uuid> | null
deal_id
string<uuid> | null
metadata
Metadata · object
user_id
string<uuid> | null
user_name
string | null

User's name or email

user_email
string | null

User's email address