Skip to main content
POST
Create an activity

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Headers

Idempotency-Key
string

Opaque client-generated key that makes a retried POST safe. Resending the same key with the SAME body replays the original response (marked with Idempotent-Replay: true) instead of creating a second record. Resending it with a DIFFERENT body is rejected with 422. Keys are scoped to your company and to the endpoint, and expire after 24 hours.

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_.:@+\-]+$

Body

application/json
entity_type
enum<string>
required
Available options:
deal,
lead
entity_id
string<uuid>
required
activity_type
string
required

Must match a configured activity type for the company (e.g. call, email, meeting).

summary
string
required
Required string length: 1 - 500
details
string
Maximum string length: 10000
performed_by_email
string<email>

Email of the performer. Defaults to first active company user.

performed_at
string<date-time>

When the activity occurred. Cannot be in the future. Defaults to now.

followup_at
string<date-time>

Scheduled follow-up date. Must be in the future.

metadata
object

Response

Activity created

success
enum<boolean>
Available options:
true
data
object
meta
object