Skip to main content
POST
Create Lead Follow-up
Schedules a new follow-up reminder or action task associated with a lead.

Request attributes

  • lead_id (string, required): Identifier of the target lead.
  • title (string, required): Short summary of the scheduled task.
  • due_date (string, required): ISO 8601 timestamp for when the task is due.
  • reminder_at (string, optional): ISO 8601 timestamp for notification alert.
  • notes (string, optional): Detailed guidance or meeting preparation notes.
  • assigned_to (string, optional): Team member responsible for the follow-up.

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.

Body

application/json
lead_id
string
required
Example:

"lead_890ef12a"

title
string
required
Example:

"Contract Review Call"

due_date
string<date-time>
required
Example:

"2026-10-30T15:00:00.000Z"

notes
string
Example:

"Discuss volume discount and renewal terms."

reminder_at
string<date-time>
Example:

"2026-10-30T14:45:00.000Z"

assigned_to
string
Example:

"user_sarah"

Response

Lead follow-up created 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