LeadStatusChanges

Update a lead status history entry

Update a Leadping lead status history entry through the API. When the entry is current, the operation also updates the lead's current status to match.

put/lead-status-changes/{id}

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/lead-status-changes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the lead status change.

Request body

expectedCurrentStatusIdstring nullable

Optional optimistic concurrency guard for the status currently displayed by the client.

expectedRevisioninteger nullable

Optional revision guard, including when the lead has no persisted status history yet.

completeFollowUpboolean

Whether the scheduled follow-up is explicitly complete.

typestring required

Category of status change being recorded for the lead.

outcomestring required

Result of the interaction or workflow step that caused the status change.

category'Open' | 'Qualified' | 'Converted' | 'Lost' | 'Invalid' | 'Duplicate' nullable

Controlled lead status change categories used for reporting, automation, and analytics.

notesstring nullable

The operator or customer notes recorded for this lead status change.

reasonstring nullable

The reason this lead status change was changed.

followUpStatusstring nullable

The current follow up status for this lead status change.

callbackAtstring date-time nullable

UTC timestamp for callback at on this lead status change.

taskDueAtstring date-time nullable

UTC timestamp for task due at on this lead status change.

appointmentStartAtstring date-time nullable

UTC timestamp for appointment start at on this lead status change.

appointmentEndAtstring date-time nullable

UTC timestamp for appointment end at on this lead status change.

appointmentNotesstring nullable

Additional scheduling or preparation notes for the related appointment.

Response

Returns the lead status change response.

revisioninteger

Monotonic revision of the lead's current status and scheduling state.

followUpCompletedAtstring date-time nullable

When this follow-up was completed; email/call activity alone does not complete it.

isDemoboolean
idstring

Unique Leadping identifier for this lead status change.

leadIdstring

The lead ID associated with this lead status change.

leadNamestring nullable

The display name of the lead associated with this lead status change.

leadEmailstring email nullable

The lead's email address, used for Gravatar fallback.

leadAvatarUrlstring uri nullable

The lead's profile image URL, when available.

typestring

Category of status change recorded for the lead.

outcomestring

Result of the interaction or workflow step that caused the status change.

category'Open' | 'Qualified' | 'Converted' | 'Lost' | 'Invalid' | 'Duplicate' nullable

Controlled lead status change categories used for reporting, automation, and analytics.

oldLeadStatusChangeIdstring nullable

Unique identifier of the old lead status change associated with this Leadping lead status change.

oldLeadStatusChangeTypestring nullable

Old lead status change type classification for this Leadping lead status change.

oldLeadStatusChangeOutcomestring nullable

Old lead status change outcome associated with this Leadping lead status change.

newLeadStatusChangeIdstring nullable

Unique identifier of the new lead status change associated with this Leadping lead status change.

notesstring

The operator or customer notes recorded for this lead status change.

reasonstring nullable

The reason this lead status change was changed.

changedByUserIdstring nullable

Unique identifier of the Leadping user who made the change.

changedByAutomationIdstring nullable

Unique identifier of the automation that changed the lead status change, when applicable.

changedAtstring date-time nullable

Date and time when the lead status change change occurred.

changeSource'User' | 'AI' | 'Automation' | 'System' | 'API' nullable

Known sources that can change a lead's current lead status change.

timestampstring date-time

UTC timestamp for timestamp on this lead status change.

createdAtstring date-time

UTC timestamp for created at on this lead status change.

updatedAtstring date-time

UTC timestamp for updated at on this lead status change.

followUpStatusstring nullable

The current follow up status for this lead status change.

callbackAtstring date-time nullable

UTC timestamp for callback at on this lead status change.

taskDueAtstring date-time nullable

UTC timestamp for task due at on this lead status change.

appointmentStartAtstring date-time nullable

UTC timestamp for appointment start at on this lead status change.

appointmentEndAtstring date-time nullable

UTC timestamp for appointment end at on this lead status change.

appointmentNotesstring nullable

Additional scheduling or preparation notes for the related appointment.

assignedToUserIdstring nullable

The assigned to user ID associated with this lead status change.

relatedCallEventIdstring nullable

The related call event ID associated with this lead status change.

isMissedCallFollowUpboolean

Whether this lead status change is missed call follow up.

sourceIdstring nullable

The source ID associated with this lead status change.

Changes

No recorded changes to this operation across all 1 revision of this API.