Skip to main content
PATCH
Update 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.

Path Parameters

id
string<uuid>
required

Query Parameters

entity_type
enum<string>

Can also be passed in request body.

Available options:
deal,
lead

Body

application/json
entity_type
enum<string>

Can also be passed as ?entity_type= query parameter.

Available options:
deal,
lead
summary
string
Maximum string length: 500
details
string
Maximum string length: 10000
activity_type
string
followup_at
string<date-time> | null

Set to null to clear follow-up.

performed_at
string<date-time>
metadata
object

Response

Activity updated

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