> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Unarchive a business lead record by ID > Restores an archived lead to active pipeline views so follow-up, communication, and routing workflows can resume. ## OpenAPI ````yaml /openapi.json post /leads/{id}/unarchive openapi: 3.0.4 info: title: Leadping API description: >- Leadping API for lead intake, messaging, calling, automations, billing, business settings, and compliant lead communication workflows. license: name: MIT url: https://opensource.org/licenses/MIT version: v1 servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: Analytics - name: Automations - name: Contact - name: Conversations - name: Dispositions - name: Feedback - name: Leads - name: LeadStatuses - name: Notifications - name: OutboundDelivery - name: Sources - name: Suppressions - name: Tags - name: Users - name: Calls - name: PhoneNumbers - name: Sms - name: Telephony - name: UserDataExports - name: CallEvents - name: Events - name: SmsEvents - name: Businesses - name: PaymentMethods - name: Transactions - name: Usage - name: Wallets paths: /leads/{id}/unarchive: post: tags: - Leads summary: Unarchive a business lead record by ID description: >- Restores an archived lead to active pipeline views so follow-up, communication, and routing workflows can resume. operationId: Leads_Unarchive parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/LeadResponse' description: >- Response schema for the Leadping API lead response returned to authenticated clients. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' components: schemas: LeadResponse: type: object properties: metadata: allOf: - $ref: '#/components/schemas/LeadMetadata' description: >- Structured metadata used for attribution, integrations, and reporting on this lead response. contact: allOf: - $ref: '#/components/schemas/LeadContact' description: >- Contact details for the lead or customer represented by this lead response. phoneIdentity: type: object allOf: - $ref: '#/components/schemas/PhoneIdentityResponse' description: Canonical phone identity and provider lookup details for this lead. nullable: true customer: allOf: - $ref: '#/components/schemas/LeadProfile' description: >- Demographic profile details for the lead represented by this lead response. enabled: type: boolean description: >- Indicates whether this lead response is active and available in the Leadping API. archivedAt: type: string description: UTC timestamp when this record was archived. format: date-time nullable: true archivedByUserId: type: string description: User ID of the person who archived this record. nullable: true archiveReason: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 type: integer description: Defines why a lead was removed from the active working pipeline. format: int32 nullable: true archiveNote: type: string description: Optional note explaining why the lead was archived. nullable: true isArchived: type: boolean description: Indicates whether the lead has been archived in Leadping. currentDisposition: type: object allOf: - $ref: '#/components/schemas/CurrentDispositionSummary' description: Current disposition summary that describes the lead outcome. nullable: true tags: type: array items: allOf: - $ref: '#/components/schemas/TagSummary' description: >- Summary schema for Leadping API tag summary data used in dashboards and reports. description: Tags currently attached to this lead, source, or record. id: type: string description: The unique identifier for the entity. createdAt: type: string description: The date and time when the entity was created. format: date-time modifiedAt: type: string description: The date and time when the entity was last modified, if applicable. format: date-time nullable: true description: >- Response schema for the Leadping API lead response returned to authenticated clients. ProblemDetails: type: object properties: type: type: string description: URI reference that identifies the problem type. nullable: true title: type: string description: Short, human-readable summary of the problem. nullable: true status: pattern: ^-?(?:0|[1-9]\d*)$ description: HTTP status code returned for the problem. format: int32 nullable: true detail: type: string description: >- Human-readable explanation specific to this occurrence of the problem. nullable: true instance: type: string description: >- URI reference that identifies this specific occurrence of the problem. nullable: true LeadMetadata: required: - trustedFormUrl type: object properties: utmSource: type: string description: UTM source parameter captured for lead attribution reporting. nullable: true utmMedium: type: string description: UTM medium parameter captured for lead attribution reporting. nullable: true utmCampaign: type: string description: UTM campaign parameter captured for lead attribution reporting. nullable: true utmTerm: type: string description: UTM term parameter captured for lead attribution reporting. nullable: true utmContent: type: string description: UTM content parameter captured for lead attribution reporting. nullable: true referrer: type: string description: Referring page or traffic source that sent the lead into Leadping. nullable: true landingPage: type: string description: Landing page URL where the lead submitted their information. nullable: true subId: type: string description: Affiliate or publisher sub ID captured for lead attribution. nullable: true pubId: type: string description: Publisher ID supplied by the lead source for attribution. nullable: true ipAddress: type: string description: >- IP address captured with the request for audit and compliance review. nullable: true userAgent: type: string description: >- Browser or client user agent captured when this lead attribution metadata was submitted. nullable: true externalId: type: string description: >- External system identifier used to reconcile this lead attribution metadata across integrations. nullable: true sellerLeadId: type: string description: >- Seller-provided lead identifier used to deduplicate and reconcile lead delivery. nullable: true createdAt: type: string description: UTC timestamp when this lead attribution metadata was created. format: date-time nullable: true price: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ description: Lead price or transaction price supplied to the Leadping API. format: double nullable: true directPostPrice: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ description: Direct-post price supplied by the lead source during intake. format: double nullable: true product: type: string description: Product or offer associated with the lead or source. nullable: true vertical: type: string description: >- Industry vertical used for lead routing, compliance review, and reporting. nullable: true complianceStatus: type: string description: Compliance status used to decide whether Leadping can send messages. nullable: true complianceBlockedReason: type: string description: Reason Leadping blocked this operation for compliance. nullable: true sourceMetadata: type: object additionalProperties: type: string description: >- Source-provided key-value metadata retained for lead attribution and integration troubleshooting. nullable: true origin: type: string description: System or workflow that created this event. nullable: true importBatchId: type: string description: Bulk import batch ID that created or updated this lead. nullable: true isImported: type: boolean description: >- Indicates whether this lead was imported rather than captured through a live source. assignedPhoneNumberId: type: string description: Phone number ID assigned to the lead, business, or source. nullable: true smsConsentStatus: type: string description: Current SMS consent status recorded for this lead. nullable: true smsOptedOut: type: boolean description: Indicates whether the lead has opted out of SMS communication. smsOptOutAt: type: string description: UTC timestamp when the lead opted out of SMS communication. format: date-time nullable: true smsOptInAt: type: string description: UTC timestamp when the lead opted in to SMS communication. format: date-time nullable: true smsHelpRequestedAt: type: string description: UTC timestamp when the lead requested SMS help instructions. format: date-time nullable: true smsConsentPhoneNumber: type: string description: Phone number where SMS consent was captured or evaluated. nullable: true trustedFormUrl: type: string description: TrustedForm certificate URL used as proof of consumer consent. userId: type: string description: User ID associated with this lead's attribution metadata. nullable: true businessId: type: string description: Business ID that owns this lead's attribution metadata. nullable: true description: Public Leadping API schema for lead attribution metadata data. LeadContact: type: object properties: firstName: type: string description: >- First name of the lead, user, or contact represented by this lead contact profile. nullable: true lastName: type: string description: >- Last name of the lead, user, or contact represented by this lead contact profile. nullable: true streetAddress: type: object allOf: - $ref: '#/components/schemas/StreetAddress' description: Postal street address for the lead contact profile. nullable: true coordinate: type: object allOf: - $ref: '#/components/schemas/Coordinate' description: Latitude and longitude coordinate for this lead contact profile. nullable: true timeZoneId: type: string description: >- IANA or Windows time zone identifier used for local scheduling and reporting. nullable: true phone: type: object allOf: - $ref: '#/components/schemas/Phone' description: >- Phone details for the lead, user, or business represented by this lead contact profile. nullable: true email: type: string description: >- Email address for the person represented by this lead contact profile. nullable: true description: Public Leadping API schema for lead contact profile data. PhoneIdentityResponse: type: object properties: number: type: string description: The canonical E.164 phone number. lookup: type: object allOf: - $ref: '#/components/schemas/PhoneLookup' description: Provider lookup and enrichment data for the number. nullable: true lastEnrichedAt: type: string description: The most recent time lookup data was enriched. format: date-time nullable: true name: type: string description: The display name for the entity. id: type: string description: The unique identifier for the entity. createdAt: type: string description: The date and time when the entity was created. format: date-time modifiedAt: type: string description: The date and time when the entity was last modified, if applicable. format: date-time nullable: true description: >- Response schema for a canonical phone identity returned by the Leadping API. LeadProfile: type: object properties: gender: enum: - M - F - NonBinary - PreferNotToSay - Other type: string description: >- Represents a gender classification used for demographic or identification purposes. nullable: true height: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Lead height provided for qualification workflows that require demographic details. format: int32 nullable: true weight: pattern: ^-?(?:0|[1-9]\d*)$ description: >- Relative weighting used to rank or score this lead demographic profile. format: int32 nullable: true birthDate: type: string description: >- Lead birth date used for demographic matching and insurance intake workflows. format: date nullable: true maritalStatus: enum: - Married - Single - Widow - Separated - Divorced type: string description: Defines the supported Marital Status Type values. nullable: true income: pattern: ^-?(?:0|[1-9]\d*)$ description: Lead income amount or range supplied for qualification workflows. format: int32 nullable: true isHomeowner: type: boolean description: Indicates whether the lead owns their home. nullable: true monthsAtResidence: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of months the lead has lived at the current residence. format: int32 nullable: true creditScore: pattern: ^-?(?:0|[1-9]\d*)$ description: Lead credit score range or score supplied by the intake source. format: int32 nullable: true hasBankruptcy: type: boolean description: Indicates whether the lead reported bankruptcy history. nullable: true employmentType: enum: - Employed - PartTime - SelfEmployed - Contractor - Unemployed - Retired - Student - Military - Homemaker - Disabled - Other type: string description: Defines the supported Employment Type values. nullable: true numberOfDependents: pattern: ^-?(?:0|[1-9]\d*)$ description: Number of dependents reported by the lead. format: int32 nullable: true hasMedicalCondition: type: boolean description: >- Indicates whether the lead reported a medical condition relevant to qualification. nullable: true description: Public Leadping API schema for lead demographic profile data. CurrentDispositionSummary: type: object properties: id: type: string description: Unique Leadping identifier for this current disposition summary. nullable: true category: enum: - Open - Qualified - Converted - Lost - Invalid - Duplicate type: string description: >- Controlled disposition categories used for reporting, automation, and analytics. nullable: true outcome: type: string description: Current disposition outcome assigned to the lead. nullable: true displayName: type: string description: >- Human-readable display name shown for this current disposition summary. changedAt: type: string description: UTC timestamp when the disposition last changed. format: date-time nullable: true changedByUserId: type: string description: User ID of the person who last changed the disposition. nullable: true changedByAutomationId: type: string description: Automation ID that last changed the disposition. nullable: true source: enum: - User - AI - Automation - System - API type: string description: Known sources that can change a lead's current disposition. nullable: true description: >- Summary schema for Leadping API current disposition summary data used in dashboards and reports. TagSummary: type: object properties: id: type: string description: Unique Leadping identifier for this tag summary. name: type: string description: Display name for this tag summary in the Leadping API. normalizedName: type: string description: >- Normalized name used for case-insensitive tag matching and deduplication. color: type: string description: Hex color used to display this tag or status in Leadping clients. nullable: true description: >- Summary schema for Leadping API tag summary data used in dashboards and reports. StreetAddress: type: object properties: line1: type: string description: >- The primary address line (e.g., street address, P.O. box, company name). nullable: true line2: type: string description: >- The secondary address line (e.g., apartment, suite, unit, or building). nullable: true city: type: string description: The city, town, or locality. nullable: true state: type: string description: >- The state, province, or equivalent administrative region. Commonly used in countries like the US, Canada, and Australia. nullable: true province: type: string description: >- The province or territory, if distinct from state in your use case (optional, use with care). nullable: true region: type: string description: >- The broader region, district, or administrative area (e.g., prefecture or county). nullable: true postalCode: type: string description: The postal or ZIP code. nullable: true country: type: string description: The ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "CA"). nullable: true additionalInfo: type: string description: Optional additional notes or delivery instructions. nullable: true description: >- A minimal, serializable record type for physical mailing addresses, with support for international formats and compatibility with common APIs. Coordinate: required: - latitude - longitude type: object properties: latitude: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ description: >- Latitude of the geographic coordinate in decimal degrees, from -90 through 90. format: double longitude: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ description: >- Longitude of the geographic coordinate in decimal degrees, from -180 through 180. format: double description: Latitude and longitude coordinate for this lead contact profile. Phone: type: object properties: phoneIdentityId: type: string description: Identifier of the canonical phone identity stored by Leadping. nullable: true number: type: string description: E.164 phone number exposed by this lead phone number. type: type: string description: >- Type classification used to route and interpret this lead phone number in the Leadping API. nullable: true description: Public Leadping API schema for lead phone number data. PhoneLookup: type: object properties: number: type: string description: E.164 phone number exposed by this phone lookup result. nullable: true isValid: type: boolean description: Indicates whether this phone lookup result passed validation. lineType: enum: - Wireline - Wireless - VoWiFi - VoIP - PrePaidWireless - Unknown type: string description: An enumerator describing phone line types nullable: true carrier: type: object allOf: - $ref: '#/components/schemas/PhoneLookupCarrier' description: Complete carrier metadata reported for this phone number. nullable: true location: type: object allOf: - $ref: '#/components/schemas/PhoneNumberLocation' description: >- Geographic location metadata for the phone number, lead, or lookup result. nullable: true id: type: string description: Gets or sets id. createdAt: type: string description: Gets or sets created at. format: date-time modifiedAt: type: string description: Gets or sets modified at. format: date-time nullable: true description: Public Leadping API schema for phone lookup result data. PhoneLookupCarrier: type: object properties: mobileCountryCode: type: string description: Mobile country code (MCC) reported by the carrier lookup. nullable: true mobileNetworkCode: type: string description: Mobile network code (MNC) reported by the carrier lookup. nullable: true name: type: string description: Human-readable name of the phone lookup carrier. nullable: true normalizedCarrier: type: string description: Normalized carrier name used for consistent matching and reporting. nullable: true type: enum: - FixedLine - Mobile - Voip - FixedLineOrMobile - TollFree - PremiumRate - SharedCost - PersonalNumber - Pager - Uan - Voicemail - Unknown type: string description: An enumerator describing carrier types nullable: true errorCode: type: string description: >- Reason or diagnostic code that explains the current outcome for this Leadping phone lookup carrier. nullable: true description: Complete carrier metadata returned by a phone number lookup provider. PhoneNumberLocation: type: object properties: location: type: string description: >- Geographic location metadata for the phone number, lead, or lookup result. nullable: true state: type: string description: State, province, or region for the lead or business postal address. nullable: true canonicalCity: type: string description: >- Canonical city resolved by Leadping from its ZIP-code geography data. nullable: true canonicalState: type: string description: Canonical state or territory abbreviation resolved by Leadping. nullable: true countryCode: type: string description: >- Country code for the phone number or location represented by this phone number location. nullable: true coordinate: type: object allOf: - $ref: '#/components/schemas/Coordinate' description: Latitude and longitude coordinate for this phone number location. nullable: true coordinateSource: type: object allOf: - $ref: '#/components/schemas/PhoneLocationSource' description: Describes how the coordinate was resolved. nullable: true timeZoneId: type: string description: >- IANA or Windows time zone identifier used for local scheduling and reporting. nullable: true timeZoneSource: type: object allOf: - $ref: '#/components/schemas/PhoneLocationSource' description: Describes how the time zone was resolved. nullable: true description: Public Leadping API schema for phone number location data. PhoneLocationSource: type: object properties: method: type: string description: >- The resolution method, such as telnyx-city-state, coordinates, phone-number, or state-default. query: type: string description: >- The city, state, coordinates, phone number, or representative ZIP used by the method. nullable: true description: Describes how a phone location value was resolved. ````