> ## 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. # Assign an organization lead to an active member, or return it to the unassigned queue. > Updates ownership of the specified lead after validating that the selected assignee is an active member of the current organization. ## OpenAPI ````yaml /openapi.json put /leads/{id}/assignment openapi: 3.1.1 info: title: Leadping API description: >- The Leadping API helps businesses capture and manage leads, automate follow-up, send SMS and MMS messages, place calls, track conversations, enforce contact suppression, and analyze communication workflows. Use this OpenAPI 3.1 contract to integrate lead sources, build organization tools, or generate a typed API client. Authenticate protected operations with a Leadping user access token or WorkOS organization API key. Lead intake operations also accept a Leadping source key. termsOfService: https://leadping.ai/docs/terms-of-service contact: name: Leadping Support url: https://leadping.ai/contact email: support@leadping.ai license: name: MIT url: https://opensource.org/licenses/MIT version: v1 summary: Lead management, messaging, calling, and automation API servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: leadping.Api description: >- Agent-to-agent discovery and request handling for Leadping's supported AI agent integrations. - name: Analytics description: >- Provides lead, communication, conversion, and organization performance analytics. Use these endpoints to measure activity over time, compare outcomes, and power operational dashboards and reporting workflows. - name: Automations description: >- Manages automated lead follow-up workflows and their execution history. Use these endpoints to configure SMS automation steps, preview eligible leads, run workflows, and inspect individual automation executions. - name: BlogArticles description: >- Provides published Leadping blog content. Use these endpoints to list published articles and retrieve an individual article by its public slug. - name: Conversations description: >- Provides lead conversation timelines and inbox-oriented conversation views. Use these endpoints to list recent conversations and retrieve the cross-channel communication history associated with a lead. - name: Feedback description: >- Captures Leadping product feedback and supports administrative triage. Users can submit feedback, while authorized staff can search, inspect, classify, and update feedback throughout the review process. - name: Leads description: >- Manages lead intake, records, assignment, routing, and lifecycle operations. Use these endpoints to ingest leads from trusted sources, search and update lead records, manage ownership and tags, and archive or delete leads. - name: LeadStatusChanges description: >- Manages the auditable history of lead status transitions. Use these endpoints to change a lead's status, correct transition records, search status history, and export status activity for reporting. - name: LeadStatuses description: >- Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting. - name: Notifications description: >- Manages user notifications, announcements, and push-notification installations. Use these endpoints to retrieve notification feeds and unread counts, update read state, and register or remove client push installations. - name: OutboundDelivery description: >- Reports outbound delivery pacing and sending capacity for the current organization. Use these endpoints to determine whether outbound communications can proceed and to understand active throttles, limits, or capacity constraints. - name: Sources description: >- Manages lead sources, intake credentials, routing defaults, and attribution. Use these endpoints to create and configure sources, search source records, inspect source activity, rotate intake access, and remove obsolete sources. - name: Suppressions description: >- Manages recipient suppression state for compliant Leadping communication workflows. Use these endpoints to check contact eligibility, record or release suppressions, and review suppression history before sending messages or placing calls. - name: Tags description: >- Manages organization-defined tags for categorizing and routing leads. Use these endpoints to list, create, update, and archive reusable tags that support lead filtering, automation, assignment, and reporting. - name: Users description: >- Manages the current Leadping user's profile, preferences, setup, and account workflows. Use these endpoints to retrieve and update user data, configure communication and compliance preferences, complete onboarding, manage plan-related actions, and request account operations. - name: Calls description: >- Manages outbound Leadping calls and active call-control workflows. Use these endpoints to initiate or cancel a call, retrieve call state, and transfer an active call within supported telephony flows. - name: PhoneNumbers description: >- Manages phone-number discovery, purchasing, assignment, configuration, and compliance. Use these endpoints to search available numbers, manage owned numbers and caller identity, configure messaging or voice behavior, and monitor registration and warmup state. - name: Sms description: >- Sends and manages SMS and MMS communications through Leadping. Use these endpoints to send messages, upload MMS media, and cancel eligible scheduled messages while preserving conversation and delivery tracking. - name: Telephony description: >- Provides shared authentication and bootstrap data for Leadping telephony clients. Use this endpoint to obtain the scoped credentials and configuration required to initialize supported calling experiences. - name: Organizations description: >- Manages Leadping organizations, memberships, invitations, settings, and API credentials. Use these endpoints to maintain organization profiles and branding, manage members and invitations, configure options, and issue or revoke organization API keys. - name: UserDataExports description: >- Creates and delivers user-requested exports of Leadping account data. Use these endpoints to request an export, monitor its preparation status, and download the completed archive through a time-limited redirect. - name: CallEvents description: >- Provides call event records for auditing, diagnostics, and reporting. Use these endpoints to search and inspect lifecycle events emitted as Leadping calls are initiated, connected, completed, or fail. - name: Events description: >- Provides a unified record of Leadping activity across communication channels. Use these endpoints to retrieve event timelines, search event history, inspect event details, and record supported application events. - name: SmsEvents description: >- Provides SMS and MMS event records for delivery tracking and diagnostics. Use these endpoints to search and inspect message lifecycle events, including outbound delivery updates and inbound messaging activity. - name: PaymentMethods description: >- Manages organization payment methods and billing invoices. Use these endpoints to add, confirm, inspect, and remove payment methods or retrieve invoices associated with the current organization's billing account. - name: Transactions description: >- Provides organization wallet and billing transaction records. Use these endpoints to search transaction history, inspect individual charges or credits, review transaction summaries, and issue administrative credits. - name: Usage description: >- Provides billable usage records for Leadping services. Use these endpoints to review messaging and calling consumption, inspect usage summaries, and reconcile provider activity for an organization. - name: Wallets description: >- Manages organization wallet balances, funding, and credit activity. Use these endpoints to inspect wallet state and history, configure wallet behavior, add funds, and record credits or adjustments. externalDocs: description: >- Leadping API documentation, authentication guide, concepts, and integration guidance. url: https://leadping.ai/docs/api-reference paths: /leads/{id}/assignment: put: tags: - Leads summary: >- Assign an organization lead to an active member, or return it to the unassigned queue. description: >- Updates ownership of the specified lead after validating that the selected assignee is an active member of the current organization. operationId: Leads_Assign parameters: - name: id in: path description: The ID of the lead whose assignment should be updated. required: true schema: type: string requestBody: description: The requested assignee, or an unassigned selection. content: application/json: schema: allOf: - $ref: '#/components/schemas/LeadAssignmentRequest' description: >- Assigns an organization lead to an active organization member. A null user ID returns the lead to the unassigned queue. application/*+json: schema: allOf: - $ref: '#/components/schemas/LeadAssignmentRequest' description: >- Assigns an organization lead to an active organization member. A null user ID returns the lead to the unassigned queue. required: true responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/LeadResponse' description: Describes lead data returned by Leadping. '400': description: The request was invalid or failed validation. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Bad Request status: 400 detail: The request could not be completed. '401': description: Authentication credentials are missing or invalid. headers: WWW-Authenticate: description: >- Bearer authentication challenge returned when credentials are missing or invalid. schema: type: string content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Unauthorized status: 401 detail: The request could not be completed. '403': description: >- The authenticated user or organization does not have permission to perform this operation. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Forbidden status: 403 detail: The request could not be completed. '404': description: The requested resource was not found. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Not Found status: 404 detail: The request could not be completed. '429': description: The API rate limit for this account or client has been exceeded. headers: Retry-After: description: Number of seconds to wait before retrying the request. schema: minimum: 0 type: integer format: int32 content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Too Many Requests status: 429 detail: The request could not be completed. security: - Bearer: [] components: schemas: LeadAssignmentRequest: type: object properties: assignedToUserId: type: - 'null' - string description: >- Assigns an organization lead to an active organization member. A null user ID returns the lead to the unassigned queue. LeadResponse: type: object properties: assignedToUserId: type: - 'null' - string description: >- Leadping user currently responsible for this lead, or null when it is in the unassigned queue. assignedTo: type: - 'null' - object allOf: - $ref: '#/components/schemas/IdNamePair' description: >- Identifier and display name of the active organization member assigned to this lead. 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: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneIdentityResponse' description: Canonical phone identity and provider lookup details for this lead. 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. deletedAt: type: - 'null' - string description: UTC timestamp when this lead was soft deleted. format: date-time deletedByUserId: type: - 'null' - string description: User ID of the person who soft deleted this lead. archivedAt: type: - 'null' - string description: UTC timestamp when this record was archived. format: date-time archivedByUserId: type: - 'null' - string description: User ID of the person who archived this record. archiveReason: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 type: - 'null' - integer description: Defines why a lead was removed from the active working pipeline. format: int32 archiveNote: type: - 'null' - string description: Optional note explaining why the lead was archived. isArchived: type: boolean description: Indicates whether the lead has been archived in Leadping. currentLeadStatus: type: - 'null' - object allOf: - $ref: '#/components/schemas/CurrentLeadStatusSummary' description: Current lead status change summary that describes the lead outcome. processingStatus: enum: - Quarantined - Verifying - Validating - Enriching - Ready - Invalid - Failed type: - 'null' - string description: >- Defines the asynchronous verification and enrichment lifecycle for a lead. processingStatusReason: type: - 'null' - string description: Explanation when asynchronous lead processing is blocked or fails. processingStatusChangedAt: type: - 'null' - string description: UTC timestamp when the processing stage last changed. format: date-time 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: Stable unique identifier of the resource. createdAt: type: string description: UTC timestamp when the resource was created. format: date-time modifiedAt: type: - 'null' - string description: >- UTC timestamp when the resource was last modified, or null when it has not been updated. format: date-time description: Describes lead data returned by Leadping. ProblemDetails: type: object properties: type: type: - 'null' - string description: URI reference that identifies the problem type. title: type: - 'null' - string description: Short, human-readable summary of the problem. status: type: - 'null' - integer description: HTTP status code returned for the problem. format: int32 detail: type: - 'null' - string description: >- Human-readable explanation specific to this occurrence of the problem. instance: type: - 'null' - string description: >- URI reference that identifies this specific occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: >- Validation errors keyed by the JSON request field name. Present for request validation failures. traceId: type: string description: >- Request trace identifier used to correlate this problem with Leadping diagnostics. description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. IdNamePair: required: - id - name type: object properties: id: type: string description: Stable unique identifier of the referenced resource. name: type: string description: Human-readable display name of the referenced resource. description: >- Provides a compact API reference to another resource using its stable identifier and human-readable display name. LeadMetadata: required: - trustedFormUrl type: object properties: utmSource: type: - 'null' - string description: UTM source parameter captured for lead attribution reporting. utmMedium: type: - 'null' - string description: UTM medium parameter captured for lead attribution reporting. utmCampaign: type: - 'null' - string description: UTM campaign parameter captured for lead attribution reporting. utmTerm: type: - 'null' - string description: UTM term parameter captured for lead attribution reporting. utmContent: type: - 'null' - string description: UTM content parameter captured for lead attribution reporting. referrer: type: - 'null' - string description: Referring page or traffic source that sent the lead into Leadping. landingPage: type: - 'null' - string description: Landing page URL where the lead submitted their information. subId: type: - 'null' - string description: Affiliate or publisher sub ID captured for lead attribution. pubId: type: - 'null' - string description: Publisher ID supplied by the lead source for attribution. ipAddress: type: - 'null' - string description: >- IP address captured with the request for audit and compliance review. userAgent: type: - 'null' - string description: >- Browser or client user agent captured when this lead attribution metadata was submitted. externalId: type: - 'null' - string description: >- External system identifier used to reconcile this lead attribution metadata across integrations. sellerLeadId: type: - 'null' - string description: >- Seller-provided lead identifier used to deduplicate and reconcile lead delivery. createdAt: type: - 'null' - string description: UTC timestamp when this lead attribution metadata was created. format: date-time price: type: - 'null' - number description: Lead price or transaction price supplied to the Leadping API. format: double directPostPrice: type: - 'null' - number description: Direct-post price supplied by the lead source during intake. format: double product: type: - 'null' - string description: Product or offer associated with the lead or source. vertical: type: - 'null' - string description: >- Industry vertical used for lead routing, compliance review, and reporting. complianceStatus: type: - 'null' - string description: Compliance status used to decide whether Leadping can send messages. complianceBlockedReason: type: - 'null' - string description: Reason Leadping blocked this operation for compliance. sourceMetadata: type: - 'null' - object additionalProperties: type: string description: >- Source-provided key-value metadata retained for lead attribution and integration troubleshooting. origin: type: - 'null' - string description: System or workflow that created this event. importBatchId: type: - 'null' - string description: Bulk import batch ID that created or updated this lead. isImported: type: boolean description: >- Indicates whether this lead was imported rather than captured through a live source. assignedPhoneNumberId: type: - 'null' - string description: Phone number ID assigned to the lead, organization, or source. smsConsentStatus: type: - 'null' - string description: Current SMS consent status recorded for this lead. smsOptedOut: type: boolean description: Indicates whether the lead has opted out of SMS communication. smsOptOutAt: type: - 'null' - string description: UTC timestamp when the lead opted out of SMS communication. format: date-time smsOptInAt: type: - 'null' - string description: UTC timestamp when the lead opted in to SMS communication. format: date-time smsHelpRequestedAt: type: - 'null' - string description: UTC timestamp when the lead requested SMS help instructions. format: date-time smsConsentPhoneNumber: type: - 'null' - string description: Phone number where SMS consent was captured or evaluated. trustedFormUrl: type: string description: TrustedForm certificate URL used as proof of consumer consent. format: uri trustedFormCheckedAt: type: - 'null' - string description: >- UTC timestamp when Leadping last successfully validated the TrustedForm certificate URL. format: date-time userId: type: - 'null' - string description: User ID associated with this lead's attribution metadata. organizationId: type: - 'null' - string description: Organization ID that owns this lead's attribution metadata. description: Public Leadping API schema for lead attribution metadata data. LeadContact: type: object properties: firstName: type: - 'null' - string description: >- First name of the lead, user, or contact represented by this lead contact profile. lastName: type: - 'null' - string description: >- Last name of the lead, user, or contact represented by this lead contact profile. streetAddress: type: - 'null' - object allOf: - $ref: '#/components/schemas/StreetAddress' description: Postal street address for the lead contact profile. coordinate: type: - 'null' - object allOf: - $ref: '#/components/schemas/Coordinate' description: Latitude and longitude coordinate for this lead contact profile. timeZoneId: type: - 'null' - string description: >- IANA or Windows time zone identifier used for local scheduling and reporting. phone: type: - 'null' - object allOf: - $ref: '#/components/schemas/Phone' description: >- Phone details for the lead, user, or organization represented by this lead contact profile. email: type: - 'null' - string description: >- Email address for the person represented by this lead contact profile. format: email avatarUrl: type: - 'null' - string description: >- Optional profile image URL for the contact. Clients fall back to Gravatar and then initials when this value is not supplied. format: uri 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: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneLookup' description: Provider lookup and enrichment data for the number. providerEnrichment: type: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneLookupProviderSnapshot' description: Lossless provider response retained for administrative diagnostics. lastEnrichedAt: type: - 'null' - string description: The most recent time lookup data was enriched. format: date-time lookupActions: type: array items: allOf: - $ref: '#/components/schemas/PhoneIdentityLookupAction' description: >- An auditable lookup, enrichment, or reputation check performed for a phone identity. description: >- Lookup, enrichment, and reputation actions performed for this identity. name: type: string description: Human-readable display name of the resource. id: type: string description: Stable unique identifier of the resource. createdAt: type: string description: UTC timestamp when the resource was created. format: date-time modifiedAt: type: - 'null' - string description: >- UTC timestamp when the resource was last modified, or null when it has not been updated. format: date-time description: >- Describes Leadping's canonical identity for a phone number, including normalization, carrier, line type, reputation, and lookup history. LeadProfile: type: object properties: gender: enum: - M - F - NonBinary - PreferNotToSay - Other type: - 'null' - string description: >- Classifies a lead's self-reported gender when required by a qualification, demographic, or integration workflow. height: type: - 'null' - integer description: >- Lead height provided for qualification workflows that require demographic details. format: int32 weight: type: - 'null' - integer description: >- Relative weighting used to rank or score this lead demographic profile. format: int32 birthDate: type: - 'null' - string description: >- Lead birth date used for demographic matching and insurance intake workflows. format: date maritalStatus: enum: - Married - Single - Widow - Separated - Divorced type: - 'null' - string description: >- Classifies a lead's reported marital status when required by a qualification or integration workflow. income: type: - 'null' - integer description: Lead income amount or range supplied for qualification workflows. format: int32 isHomeowner: type: - 'null' - boolean description: Indicates whether the lead owns their home. monthsAtResidence: type: - 'null' - integer description: Number of months the lead has lived at the current residence. format: int32 creditScore: type: - 'null' - integer description: Lead credit score range or score supplied by the intake source. format: int32 hasBankruptcy: type: - 'null' - boolean description: Indicates whether the lead reported bankruptcy history. employmentType: enum: - Employed - PartTime - SelfEmployed - Contractor - Unemployed - Retired - Student - Military - Homemaker - Disabled - Other type: - 'null' - string description: >- Classifies a lead's reported employment arrangement for qualification and demographic workflows. numberOfDependents: type: - 'null' - integer description: Number of dependents reported by the lead. format: int32 hasMedicalCondition: type: - 'null' - boolean description: >- Indicates whether the lead reported a medical condition relevant to qualification. description: Public Leadping API schema for lead demographic profile data. CurrentLeadStatusSummary: type: object properties: id: type: - 'null' - string description: >- Unique Leadping identifier for this current lead status change summary. category: enum: - Open - Qualified - Converted - Lost - Invalid - Duplicate type: - 'null' - string description: >- Controlled lead status change categories used for reporting, automation, and analytics. outcome: type: - 'null' - string description: Current lead status change outcome assigned to the lead. displayName: type: string description: >- Human-readable display name shown for this current lead status change summary. changedAt: type: - 'null' - string description: UTC timestamp when the lead status change last changed. format: date-time changedByUserId: type: - 'null' - string description: User ID of the person who last changed the lead status change. changedByAutomationId: type: - 'null' - string description: Automation ID that last changed the lead status change. source: enum: - User - AI - Automation - System - API type: - 'null' - string description: Known sources that can change a lead's current lead status change. description: >- Summary schema for Leadping API current lead status change 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: - 'null' - string description: Hex color used to display this tag or status in Leadping clients. description: >- Summary schema for Leadping API tag summary data used in dashboards and reports. StreetAddress: type: object properties: line1: type: - 'null' - string description: >- Primary delivery line, such as a street address, post-office box, or company name. line2: type: - 'null' - string description: >- Secondary delivery line, such as an apartment, suite, unit, floor, or building. city: type: - 'null' - string description: City, town, village, or other postal locality. state: type: - 'null' - string description: >- State or equivalent first-level administrative subdivision when that label is used by the country. province: type: - 'null' - string description: >- Province or territory when represented separately from State by the source or destination system. region: type: - 'null' - string description: >- Region, district, county, prefecture, or other administrative area not represented by state or province. postalCode: type: - 'null' - string description: >- Postal routing code, such as a ZIP code or postcode, formatted according to the destination country. country: type: - 'null' - string description: Two-letter ISO 3166-1 alpha-2 country code, such as US, GB, or CA. additionalInfo: type: - 'null' - string description: >- Additional address context or delivery instructions that do not fit the structured fields. description: >- Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields. Coordinate: required: - latitude - longitude type: object properties: latitude: type: number description: >- Latitude of the geographic coordinate in decimal degrees, from -90 through 90. format: double longitude: type: number 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: - 'null' - string description: Identifier of the canonical phone identity stored by Leadping. number: type: string description: E.164 phone number exposed by this lead phone number. type: type: - 'null' - string description: >- Type classification used to route and interpret this lead phone number in the Leadping API. description: Public Leadping API schema for lead phone number data. PhoneLookup: type: object properties: number: type: - 'null' - string description: E.164 phone number exposed by this phone lookup result. nationalFormat: type: - 'null' - string description: Provider-formatted national phone number. recordType: type: - 'null' - string description: Provider record discriminator. fraud: type: - 'null' - string description: Fraud value returned by the provider, when available. isValid: type: boolean description: Indicates whether this phone lookup result passed validation. lineType: enum: - Wireline - Wireless - VoWiFi - VoIP - PrePaidWireless - Unknown type: - 'null' - string description: >- Classifies the access technology or service type associated with a telephone number. carrier: type: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneLookupCarrier' description: Complete carrier metadata reported for this phone number. callerName: type: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneLookupCallerName' description: Caller-name data returned by the provider. portability: type: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneLookupPortability' description: Complete portability data returned by Telnyx. location: type: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneNumberLocation' description: >- Geographic location metadata for the phone number, lead, or lookup result. id: type: string description: Stable unique identifier of the resource. createdAt: type: string description: UTC timestamp when the resource was created. format: date-time modifiedAt: type: - 'null' - string description: >- UTC timestamp when the resource was last modified, or null when it has not been updated. format: date-time description: Public Leadping API schema for phone lookup result data. PhoneLookupProviderSnapshot: type: object properties: provider: type: string description: The provider that supplied the phone lookup record. lookupType: type: string description: >- The provider lookup product or operation that produced this snapshot. schemaVersion: type: integer description: >- The Leadping schema version used to interpret the stored provider record. format: int32 retrievedAt: type: string description: The UTC timestamp when Leadping retrieved the provider record. format: date-time rawRecordJson: type: string description: >- The complete provider response serialized as JSON for lossless audit and replay. description: >- Lossless provider snapshot retained with a phone identity for replay, audits, and fields added by providers later. PhoneIdentityLookupAction: type: object properties: id: type: string description: The unique identifier of this phone identity lookup action. type: allOf: - $ref: '#/components/schemas/PhoneIdentityLookupActionType' description: >- The category of enrichment, validation, or reputation lookup that was performed. provider: type: string description: The provider that performed the phone identity lookup. status: allOf: - $ref: '#/components/schemas/PhoneIdentityLookupActionStatus' description: The processing outcome reported for the phone identity lookup. occurredAt: type: string description: The UTC timestamp when the lookup action occurred. format: date-time providerCostAmount: type: - 'null' - number description: The provider cost incurred by this lookup action, in USD. format: double providerPricingVersion: type: - 'null' - string description: The provider pricing version used to calculate the lookup cost. description: >- An auditable lookup, enrichment, or reputation check performed for a phone identity. PhoneLookupCarrier: type: object properties: mobileCountryCode: type: - 'null' - string description: Mobile country code (MCC) reported by the carrier lookup. mobileNetworkCode: type: - 'null' - string description: Mobile network code (MNC) reported by the carrier lookup. name: type: - 'null' - string description: Human-readable name of the phone lookup carrier. normalizedCarrier: type: - 'null' - string description: Normalized carrier name used for consistent matching and reporting. type: enum: - FixedLine - Mobile - Voip - FixedLineOrMobile - TollFree - PremiumRate - SharedCost - PersonalNumber - Pager - Uan - Voicemail - Unknown type: - 'null' - string description: >- Classifies a telephone number by the network service or carrier category that provides it. errorCode: type: - 'null' - string description: >- Reason or diagnostic code that explains the current outcome for this Leadping phone lookup carrier. description: Complete carrier metadata returned by a phone number lookup provider. PhoneLookupCallerName: type: object properties: name: type: - 'null' - string description: >- Caller name associated with the phone number, when reported by the provider. errorCode: type: - 'null' - string description: >- Provider error code returned when caller-name data could not be resolved. description: Caller-name data returned by the phone lookup provider. PhoneLookupPortability: type: object properties: alternativeSpid: type: - 'null' - string description: Alternative service provider identifier reported for the number. alternativeCarrierName: type: - 'null' - string description: >- Name of the carrier associated with the alternative service provider identifier. alternativeCarrierType: type: - 'null' - string description: >- Carrier type associated with the alternative service provider identifier. city: type: - 'null' - string description: City reported by the portability lookup. lineType: type: - 'null' - string description: Provider-native line type reported by the portability lookup. localRoutingNumber: type: - 'null' - string description: Local routing number used to route calls for the ported number. operatingCompanyNumber: type: - 'null' - string description: Operating company number associated with the phone number. portedDate: type: - 'null' - string description: >- Date on which the phone number was ported, as reported by the provider. portedStatus: type: - 'null' - string description: Current number-portability status reported by the provider. spid: type: - 'null' - string description: Service provider identifier currently associated with the number. carrierName: type: - 'null' - string description: Name of the carrier currently serving the number. carrierType: type: - 'null' - string description: Type of carrier currently serving the number. state: type: - 'null' - string description: State or region reported by the portability lookup. description: Number-portability and routing data returned by Telnyx. PhoneNumberLocation: type: object properties: location: type: - 'null' - string description: >- Geographic location metadata for the phone number, lead, or lookup result. state: type: - 'null' - string description: >- State, province, or region for the lead or organization postal address. canonicalCity: type: - 'null' - string description: >- Canonical city resolved by Leadping from its ZIP-code geography data. canonicalState: type: - 'null' - string description: Canonical state or territory abbreviation resolved by Leadping. countryCode: type: - 'null' - string description: >- Country code for the phone number or location represented by this phone number location. coordinate: type: - 'null' - object allOf: - $ref: '#/components/schemas/Coordinate' description: Latitude and longitude coordinate for this phone number location. coordinateSource: type: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneLocationSource' description: Describes how the coordinate was resolved. timeZoneId: type: - 'null' - string description: >- IANA or Windows time zone identifier used for local scheduling and reporting. timeZoneSource: type: - 'null' - object allOf: - $ref: '#/components/schemas/PhoneLocationSource' description: Describes how the time zone was resolved. description: Public Leadping API schema for phone number location data. PhoneIdentityLookupActionType: enum: - validation - enrichment - unwanted-number-check type: string description: Identifies the kind of lookup action performed for a phone identity. PhoneIdentityLookupActionStatus: enum: - succeeded - failed type: string description: Identifies the outcome of a phone identity lookup action. PhoneLocationSource: type: object properties: method: type: string description: >- The resolution method, such as Telnyx-city-state, coordinates, phone-number, or state-default. query: type: - 'null' - string description: >- The city, state, coordinates, phone number, or representative ZIP used by the method. description: Describes how a phone location value was resolved. securitySchemes: Bearer: type: http description: >- Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_. scheme: bearer bearerFormat: JWT or organization API key ````