Leads

Archive a lead

Marks a lead as archived. Archived leads are hidden from the default lead list.

Required permission: lead_write

put/api/v1/leads/{lead_id}/archive

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/leads/{lead_id}/archive
  • Auth: none declared. Required headers: Api-Key

Path parameters

lead_idinteger required

The unique ID of the lead

Headers

Api-Keystring required

Your Integration Key

Response

lead archived

Changes

No recorded changes to this operation across all 2 revisions of this API.