Leads

Archive an organization lead record by ID

Archive a lead to remove it from active pipeline views while preserving communication and event history. An optional request body supplies the archive reason.

post/leads/{id}/archive

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/leads/{id}/archive
  • Auth: HTTP bearer

Path parameters

idstring required

The unique identifier of the lead to archive.

Request body

reason0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

Defines why a lead was removed from the active working pipeline.

notestring nullable

Optional archive note that gives additional context for why the lead was archived.

Response

OK

isDemoboolean
assignedToUserIdstring nullable

Leadping user currently responsible for this lead, or null when it is in the unassigned queue.

enabledboolean

Indicates whether this lead response is active and available in the Leadping API.

deletedAtstring date-time nullable

UTC timestamp when this lead was soft deleted.

deletedByUserIdstring nullable

User ID of the person who soft deleted this lead.

archivedAtstring date-time nullable

UTC timestamp when this record was archived.

archivedByUserIdstring nullable

User ID of the person who archived this record.

archiveReason0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 nullable

Defines why a lead was removed from the active working pipeline.

archiveNotestring nullable

Optional note explaining why the lead was archived.

isArchivedboolean

Indicates whether the lead has been archived in Leadping.

processingStatus'Quarantined' | 'Verifying' | 'Validating' | 'Enriching' | 'Ready' | 'Invalid' | 'Failed' nullable

Defines the asynchronous verification and enrichment lifecycle for a lead.

processingStatusReasonstring nullable

Explanation when asynchronous lead processing is blocked or fails.

processingStatusChangedAtstring date-time nullable

UTC timestamp when the processing stage last changed.

idstring
createdAtstring date-time
modifiedAtstring date-time nullable

Changes

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