Skip to main content
PATCH
Update Lead Follow-up
Updates an existing lead follow-up task, reschedules dates, or transitions its status.

Path parameters

  • id (string, required): The unique identifier of the follow-up.

Status values

  • pending: Active task awaiting completion.
  • completed: Successfully completed follow-up.
  • cancelled: Task cancelled or no longer required.

Required permissions

Requires an API key with the crm:write scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Path Parameters

id
string
required

The unique identifier of the follow-up

Body

application/json
title
string
Example:

"Rescheduled Review Call"

notes
string
Example:

"Client requested meeting push."

due_date
string<date-time>
Example:

"2026-11-02T16:00:00.000Z"

reminder_at
string<date-time>
Example:

"2026-11-02T15:45:00.000Z"

status
enum<string>
Available options:
pending,
completed,
cancelled
Example:

"completed"

assigned_to
string
Example:

"user_sarah"

Response

Lead follow-up updated successfully

Standard envelope returned by POST, PATCH, PUT, and DELETE (mutation) endpoints

success
boolean
required
Example:

true

data
object
required

The created or updated entity

error
null
required
Example:

null