{ "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" } ], "paths": { "/.well-known/agent-card.json": { "get": { "tags": [ "leadping.Api" ], "summary": "Get the Leadping A2A Agent Card", "description": "Returns Leadping's public A2A Agent Card, including protocol capabilities, authentication requirements, input and output modes, and supported skills.", "operationId": "A2A_GetAgentCard", "responses": { "200": { "description": "OK" }, "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." } } } } }, "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": false }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/a2a": { "post": { "tags": [ "leadping.Api" ], "summary": "Handle an A2A request", "description": "Accepts authenticated A2A JSON-RPC requests for Leadping's supported agent operations.", "operationId": "A2A_HandleRequest", "responses": { "200": { "description": "OK" }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/analytics/my": { "get": { "tags": [ "Analytics" ], "summary": "Get organization lead communication analytics", "description": "Returns current-organization analytics for lead communication, including event volume, response metrics, and date-range filtering.", "operationId": "Analytics_GetCurrentOrganization", "parameters": [ { "name": "startAt", "in": "query", "description": "Optional inclusive start timestamp for the analytics period.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endAt", "in": "query", "description": "Optional exclusive end timestamp for the analytics period.", "schema": { "type": "string", "format": "date-time" } }, { "name": "days", "in": "query", "description": "Optional number of recent days to include when explicit timestamps are not supplied.", "schema": { "type": [ "null", "integer" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CustomerAnalyticsResponse" } ], "description": "Aggregates an organization's lead performance, response speed, communication usage, automation health, and activation insights." } } } }, "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." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/automations": { "post": { "tags": [ "Automations" ], "summary": "Create an organization lead follow-up automation", "description": "Creates an automation for current-organization leads, configuring triggers, message steps, and follow-up behavior.", "operationId": "Automations_Create", "requestBody": { "description": "The automation request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationRequest" } ], "description": "Defines the fields clients can send when working with automation configuration." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationRequest" } ], "description": "Defines the fields clients can send when working with automation configuration." } } }, "required": true }, "responses": { "201": { "description": "The automation response was created successfully.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationResponse" } ], "description": "Describes automation configuration 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/automations/{id}": { "put": { "tags": [ "Automations" ], "summary": "Update an organization lead follow-up automation", "description": "Updates an automation for current-organization leads, changing triggers, message steps, routing, or active follow-up settings.", "operationId": "Automations_Update", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the automation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The automation request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationRequest" } ], "description": "Defines the fields clients can send when working with automation configuration." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationRequest" } ], "description": "Defines the fields clients can send when working with automation configuration." } } }, "required": true }, "responses": { "200": { "description": "Returns the automation response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationResponse" } ], "description": "Describes automation configuration 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." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "get": { "tags": [ "Automations" ], "summary": "Get an organization lead follow-up automation", "description": "Returns one automation for the current organization, including trigger criteria, message steps, routing settings, and enabled state.", "operationId": "Automations_Get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the automation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the automation response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationResponse" } ], "description": "Describes automation configuration data returned by Leadping." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "delete": { "tags": [ "Automations" ], "summary": "Delete an organization lead follow-up automation", "description": "Deletes an automation for the current organization so it no longer schedules follow-up or routing work for captured leads.", "operationId": "Automations_Delete", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the automation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the bool.", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/automations/{id}/runs": { "get": { "tags": [ "Automations" ], "summary": "Gets recent persisted execution runs for an automation console.", "description": "Returns recent execution history for the specified automation in the current organization, including run state and console details.", "operationId": "Automations_GetRuns", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the automation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the automation execution history.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationConsoleResponse" } ], "description": "Recent persisted execution runs for an automation console." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/automations/{id}/runs/{runId}": { "get": { "tags": [ "Automations" ], "summary": "Gets one persisted automation execution run for its console.", "description": "Returns the specified persisted execution run for an automation in the current organization, including its current console state.", "operationId": "Automations_GetRun", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the automation.", "required": true, "schema": { "type": "string" } }, { "name": "runId", "in": "path", "description": "The unique identifier of the persisted automation run.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the requested automation execution run.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationConsoleResponse" } ], "description": "Recent persisted execution runs for an automation console." } } } }, "404": { "description": "The automation or execution run 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/automations/all/my": { "post": { "tags": [ "Automations" ], "summary": "List organization lead follow-up automations", "description": "Lists current-user automations with paging, sorting, and filters for reviewing follow-up workflows and ownership.", "operationId": "Automations_GetAllForCurrentUser", "requestBody": { "description": "The filtering, sorting, and pagination options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged automation table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfAutomationTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/automations/preview": { "post": { "tags": [ "Automations" ], "summary": "Preview a lead follow-up automation", "description": "Previews automation execution for a sample lead, showing matched steps and messages without creating follow-up events.\nSet `validate_only` to return configuration validation without evaluating conditions or actions and without writing a test audit event.", "operationId": "Automations_Preview", "parameters": [ { "name": "validate_only", "in": "query", "description": "When true, validates the automation without evaluating actions or writing an audit event.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The automation preview request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationPreviewRequest" } ], "description": "Defines the fields clients can send when working with automation preview." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationPreviewRequest" } ], "description": "Defines the fields clients can send when working with automation preview." } } }, "required": true }, "responses": { "200": { "description": "Returns the automation preview response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationPreviewResponse" } ], "description": "Describes automation preview 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/automations/{id}/run": { "post": { "tags": [ "Automations" ], "summary": "Runs an automation through its Manual trigger.", "description": "Starts the specified automation through its manual trigger and returns the newly created execution record.", "operationId": "Automations_RunManual", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the automation to run.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the newly created automation execution record.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationRunRecord" } ], "description": "History record schema for Leadping API automation run record data exposed in automation and audit views." } } } }, "400": { "description": "The automation cannot be run with its current configuration or state.", "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." } } } }, "403": { "description": "The authenticated user is not allowed to run this automation.", "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." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/blog": { "get": { "tags": [ "BlogArticles" ], "summary": "Lists published blog articles.", "description": "Returns the Leadping blog articles currently available to public readers.", "operationId": "BlogArticles_GetPublished", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/BlogArticleResponse" } ], "description": "Represents a blog article response." } } } } }, "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": [ ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": false }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/blog/{slug}": { "get": { "tags": [ "BlogArticles" ], "summary": "Gets a published blog article by slug.", "description": "Returns the public article identified by its URL slug, or a not-found response when no published article matches.", "operationId": "BlogArticles_GetPublishedBySlug", "parameters": [ { "name": "slug", "in": "path", "description": "The public URL slug of the published article.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BlogArticleResponse" } ], "description": "Represents a blog article response." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BlogArticleResponse" } ], "description": "Represents a blog article response." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BlogArticleResponse" } ], "description": "Represents a blog article response." } } } }, "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": [ ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": false }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/conversations/my": { "post": { "tags": [ "Conversations" ], "summary": "List current user's inbox conversations", "description": "Lists the current user's lead conversations with paging and sorting for inbox views, recent follow-up, and communication history.", "operationId": "Conversations_GetAllForCurrentUser", "parameters": [ { "name": "archiveFilter", "in": "query", "description": "Optional filter selecting active, archived, or all lead conversations.", "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options for the inbox.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged conversation response.", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfConversationResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfConversationResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfConversationResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/conversations/{id}/mark-read": { "post": { "tags": [ "Conversations" ], "summary": "Marks an inbox conversation as read.", "description": "Updates the conversation's read state for the current user's inbox and returns whether the conversation was found.", "operationId": "Conversations_MarkAsRead", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the conversation to mark as read.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "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." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/conversations/lead/{leadId}": { "post": { "tags": [ "Conversations" ], "summary": "List inbox conversations for a lead", "description": "Lists conversations for one lead, helping users inspect communication threads, recent follow-up, and related events.", "operationId": "Conversations_GetConversationsByLead", "parameters": [ { "name": "leadId", "in": "path", "description": "The lead ID to get conversations for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options for the lead's conversations.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged conversation response.", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfConversationResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfConversationResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfConversationResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/feedback": { "post": { "tags": [ "Feedback" ], "summary": "Create product feedback for an organization", "description": "Creates product feedback for the current organization, capturing category, message, and context for operator review.", "operationId": "Feedback_Create", "requestBody": { "description": "The feedback category, message, and optional product context to submit.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FeedbackCreateRequest" } ], "description": "Defines the fields clients can send when working with feedback creation." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FeedbackCreateRequest" } ], "description": "Defines the fields clients can send when working with feedback creation." } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FeedbackResponse" } ], "description": "Describes feedback item 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads": { "post": { "tags": [ "Leads" ], "summary": "Create a lead record from an external source", "description": "Creates a source-authenticated lead captured outside Leadping, starting follow-up, routing, and automation from structured lead data.", "operationId": "Leads_CreateExternal", "requestBody": { "description": "The lead data submitted by the external system.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadRequest" } ], "description": "Defines the fields clients can send when working with lead." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadRequest" } ], "description": "Defines the fields clients can send when working with lead." } } }, "required": true }, "responses": { "201": { "description": "Lead was successfully created.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "404": { "description": "A related 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." } } } }, "400": { "description": "The request was invalid or malformed.", "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": "Source credentials are missing or invalid.", "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 source is not allowed to accept traffic.", "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." } } } }, "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": [ { "SourceKey": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": false }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/intake": { "post": { "tags": [ "Leads" ], "summary": "Create a lead record from intake payload", "description": "Creates a source-authenticated lead from a flat intake payload, capturing contact fields, metadata, and automation-ready lead details.", "operationId": "Leads_CreateIntake", "requestBody": { "description": "The common lead fields submitted by the external system.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadIntakeRequest" } ], "description": "Defines the fields clients can send when working with lead intake." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadIntakeRequest" } ], "description": "Defines the fields clients can send when working with lead intake." } } }, "required": true }, "responses": { "201": { "description": "The lead response was created successfully.", "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": "Source credentials are missing or invalid.", "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 source is not allowed to accept traffic.", "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." } } } }, "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": [ { "SourceKey": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": false }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/{id}": { "get": { "tags": [ "Leads" ], "summary": "Get an organization lead record for current user", "description": "Returns one lead visible to the current user, including communication details, status, source, and follow-up context.", "operationId": "Leads_GetForCurrentUser", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the lead to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lead was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "404": { "description": "The specified lead 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." } } } }, "401": { "description": "The user does not own this lead.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "put": { "tags": [ "Leads" ], "summary": "Update an organization lead record and status", "description": "Updates lead details for the current organization, keeping contact data, status, source, and follow-up context current.", "operationId": "Leads_Update", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the lead to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated lead data.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadRequest" } ], "description": "Defines the fields clients can send when working with lead." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadRequest" } ], "description": "Defines the fields clients can send when working with lead." } } }, "required": true }, "responses": { "200": { "description": "Lead was successfully updated.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "404": { "description": "The specified lead 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." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "delete": { "tags": [ "Leads" ], "summary": "Delete an organization lead record by ID", "description": "Marks a lead as deleted so it no longer appears in user-facing lead, conversation, routing, or event workflows. The stored lead,\nconversation, and event records are retained.", "operationId": "Leads_Delete", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the lead to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Lead was successfully deleted." }, "404": { "description": "The specified lead 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/{id}/workflow-status": { "get": { "tags": [ "Leads" ], "summary": "Get a lead automation workflow status", "description": "Returns automation workflow status for one lead, including active runs, paused state, and follow-up progress for the current organization.", "operationId": "Leads_GetWorkflowStatusForCurrentUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the lead whose workflow status to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AutomationWorkflowStatusResponse" } ], "description": "Automation workflow status collection for a lead." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/leads/{id}/archive": { "post": { "tags": [ "Leads" ], "summary": "Archive an organization lead record by ID", "description": "Archives a lead without deleting history, removing it from active pipeline views while preserving communication and event records.\nThe request body is intentionally optional. An empty body archives the lead with the default manually-archived reason.", "operationId": "Leads_Archive", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the lead to archive.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional archive reason and related audit context. Omit the body to use the default manually-archived reason.", "content": { "application/json": { "schema": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/LeadArchiveRequest" } ], "description": "Defines the fields clients can send when working with lead archive." } }, "application/*+json": { "schema": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/LeadArchiveRequest" } ], "description": "Defines the fields clients can send when working with lead archive." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "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." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true }, "reversibility": { "supported": true, "operation-id": "Leads_Unarchive", "window": "While the lead remains archived." } } } }, "/leads/{id}/unarchive": { "post": { "tags": [ "Leads" ], "summary": "Unarchive an organization 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", "description": "The unique identifier of the archived lead to restore.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/all/my": { "post": { "tags": [ "Leads" ], "summary": "List organization lead records for current user", "description": "Lists leads visible to the current user with paging, sorting, filters, tags, and archive status for pipeline review.", "operationId": "Leads_GetAllForCurrentUser", "parameters": [ { "name": "tagIds", "in": "query", "description": "Optional tag identifiers used to filter the lead list.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tagMatchAll", "in": "query", "description": "Whether a lead must contain every supplied tag instead of any supplied tag.", "schema": { "type": "boolean" } }, { "name": "untagged", "in": "query", "description": "Whether to include only leads that have no tags.", "schema": { "type": "boolean" } }, { "name": "archiveFilter", "in": "query", "description": "Optional filter selecting active, archived, or all leads.", "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options for lead records.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Leads were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfLeadTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/{id}/tags": { "post": { "tags": [ "Leads" ], "summary": "Add organization tags to a lead record by ID", "description": "Adds one or more current-organization tags to a lead so users can segment, filter, route, and review follow-up work.", "operationId": "Leads_AddTags", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the lead to tag.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The organization tag identifiers to add to the lead.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadTagsRequest" } ], "description": "Defines the fields clients can send when working with lead tag update." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadTagsRequest" } ], "description": "Defines the fields clients can send when working with lead tag update." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "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." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "put": { "tags": [ "Leads" ], "summary": "Replace organization tags on a lead record", "description": "Replaces all tags on a lead with the supplied current-organization tags, keeping segmentation and routing labels in sync.", "operationId": "Leads_ReplaceTags", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the lead whose tags to replace.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The complete replacement set of organization tag identifiers.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadTagsRequest" } ], "description": "Defines the fields clients can send when working with lead tag update." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadTagsRequest" } ], "description": "Defines the fields clients can send when working with lead tag update." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "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." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/{id}/tags/{tagId}": { "delete": { "tags": [ "Leads" ], "summary": "Remove an organization tag from a lead record", "description": "Removes one current-organization tag from a lead while leaving the lead record, other tags, and communication history intact.", "operationId": "Leads_RemoveTag", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the lead to update.", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "description": "The unique identifier of the organization tag to remove.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadResponse" } ], "description": "Describes lead data returned by Leadping." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/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." } } } }, "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." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/{leadId}/status": { "put": { "tags": [ "LeadStatusChanges" ], "summary": "Set a lead's current status", "description": "Sets the lead's current structured status and records the change for audit, automation, and reporting.", "operationId": "LeadStatusChanges_SetCurrent", "parameters": [ { "name": "leadId", "in": "path", "description": "The lead identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new status and related workflow data.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeRequest" } ], "description": "Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeRequest" } ], "description": "Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context." } } }, "required": true }, "responses": { "200": { "description": "The lead status was successfully updated and recorded.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeResponse" } ], "description": "Describes an auditable lead status transition, including the previous and new status, source, actor, and effective time." } } } }, "404": { "description": "A related 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." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/lead-status-changes/{id}": { "put": { "tags": [ "LeadStatusChanges" ], "summary": "Update a lead status history entry", "description": "Updates a lead status history entry and, when it is current, updates the lead's current status.", "operationId": "LeadStatusChanges_Update", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the lead status change.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The lead status change request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeRequest" } ], "description": "Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeRequest" } ], "description": "Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context." } } }, "required": true }, "responses": { "200": { "description": "Returns the lead status change response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeResponse" } ], "description": "Describes an auditable lead status transition, including the previous and new status, source, actor, and effective time." } } } }, "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." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "get": { "tags": [ "LeadStatusChanges" ], "summary": "Get a lead status history entry", "description": "Returns one lead status change record so users can review a lead outcome, related notes, and follow-up context.", "operationId": "LeadStatusChanges_Get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the lead status change to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The lead status change was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeResponse" } ], "description": "Describes an auditable lead status transition, including the previous and new status, source, actor, and effective time." } } } }, "404": { "description": "The specified lead status change 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "delete": { "tags": [ "LeadStatusChanges" ], "summary": "Delete a lead status history entry", "description": "Deletes a lead status change from a lead when the outcome record should no longer appear in event or reporting views.", "operationId": "LeadStatusChanges_Delete", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the lead status change to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The lead status change was successfully deleted.", "content": { "application/json": { } } }, "404": { "description": "The specified lead status change 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/lead-status-changes/all/my": { "post": { "tags": [ "LeadStatusChanges" ], "summary": "List current-organization lead status history", "description": "Returns a filtered, paginated history of lead status changes for the current organization for workflow analysis, reporting, and audit review.", "operationId": "LeadStatusChanges_GetAllForCurrentOrganization", "requestBody": { "description": "Pagination, filtering, and sorting options for the lead status history.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfLeadStatusChangeResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/leads/{leadId}/status-history": { "get": { "tags": [ "LeadStatusChanges" ], "summary": "List a lead's status history", "description": "Lists lead status change outcome history for one lead, including prior outcomes, notes, follow-up context, timestamps, and actor details used for audit review.", "operationId": "LeadStatusChanges_GetByLeadId", "parameters": [ { "name": "leadId", "in": "path", "description": "The ID of the lead to get lead status changes for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The lead status history was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeResponse" } ], "description": "Describes an auditable lead status transition, including the previous and new status, source, actor, and effective time." } } } } }, "404": { "description": "The specified lead 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/leads/{leadId}/status-history/export": { "get": { "tags": [ "LeadStatusChanges" ], "summary": "Export a lead's status history", "description": "Exports lead status change data for one lead, packaging outcome history for reporting, audit review, or handoff workflows.", "operationId": "LeadStatusChanges_ExportByLeadId", "parameters": [ { "name": "leadId", "in": "path", "description": "The lead identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the lead status change export response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeExportResponse" } ], "description": "Describes lead status change export data returned by Leadping." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/lead-statuses": { "get": { "tags": [ "LeadStatuses" ], "summary": "List the current organization's lead statuses", "description": "Lists the current organization's active lead statuses for organizing and tracking leads through the sales workflow.", "operationId": "LeadStatuses_GetAll", "responses": { "200": { "description": "The active lead statuses available to the current organization.", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusResponse" } ], "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." } } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "post": { "tags": [ "LeadStatuses" ], "summary": "Create an organization lead status", "description": "Creates a reusable lead status for the current organization to categorize, organize, and track leads consistently throughout its sales and follow-up workflow.", "operationId": "LeadStatuses_Create", "requestBody": { "description": "The lead status name, color, and display order to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusRequest" } ], "description": "Defines the editable values used to create or update a lead status." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusRequest" } ], "description": "Defines the editable values used to create or update a lead status." } } }, "required": true }, "responses": { "201": { "description": "The newly created lead status.", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusResponse" } ], "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusResponse" } ], "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusResponse" } ], "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/lead-statuses/{id}": { "put": { "tags": [ "LeadStatuses" ], "summary": "Update an organization lead status", "description": "Updates the name, color, and display order of a lead status owned by the current organization so pipeline stages remain clear and consistently organized.", "operationId": "LeadStatuses_Update", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the lead status to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The replacement lead status name, color, and display order.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusRequest" } ], "description": "Defines the editable values used to create or update a lead status." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusRequest" } ], "description": "Defines the editable values used to create or update a lead status." } } }, "required": true }, "responses": { "200": { "description": "The updated lead status.", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusResponse" } ], "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusResponse" } ], "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusResponse" } ], "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "delete": { "tags": [ "LeadStatuses" ], "summary": "Archive an organization lead status", "description": "Archives a lead status for the current organization so it is unavailable for new assignments while existing lead history is preserved.", "operationId": "LeadStatuses_Archive", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the lead status to archive.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`true` after the lead status is archived.", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/notifications/{id}": { "get": { "tags": [ "Notifications" ], "summary": "Get a current-user notification", "description": "Returns one notification for the current user and organization, including its content, read state, delivery context, and relevant account activity.", "operationId": "Notifications_GetForCurrentUser", "parameters": [ { "name": "id", "in": "path", "description": "The notification ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NotificationResponse" } ], "description": "Describes notification data used in Leadping API requests and responses." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/notifications/me": { "post": { "tags": [ "Notifications" ], "summary": "List notifications for current user", "description": "Lists current-user notifications with paging, sorting, and filters for operational alerts, announcements, and follow-up updates.", "operationId": "Notifications_GetAllForCurrentUser", "parameters": [ { "name": "startAt", "in": "query", "description": "Inclusive beginning of the created date range.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endAt", "in": "query", "description": "Exclusive end of the created date range.", "schema": { "type": "string", "format": "date-time" } } ], "requestBody": { "description": "Request data options for pagination, filtering, and sorting.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged notification table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfNotificationTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/notifications/unread-count": { "get": { "tags": [ "Notifications" ], "summary": "Get unread notifications for current user", "description": "Returns the current user's unread notification count for badge updates and notification center state.", "operationId": "Notifications_GetUnreadCount", "responses": { "200": { "description": "Returns the int.", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/notifications/{id}/mark-read": { "post": { "tags": [ "Notifications" ], "summary": "Mark a current-user notification as read", "description": "Marks one current-user notification as read so it no longer contributes to unread counts or active notification lists.", "operationId": "Notifications_MarkAsRead", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the notification to mark as read.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the bool.", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "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." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/notifications/mark-all-read": { "post": { "tags": [ "Notifications" ], "summary": "Mark all current-user notifications as read", "description": "Marks all notifications for the current user as read and returns the number updated for notification center refreshes.", "operationId": "Notifications_MarkAllAsRead", "responses": { "200": { "description": "Returns the int.", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/notifications/announcements": { "post": { "tags": [ "Notifications" ], "summary": "List announcements for current user", "description": "Lists announcement notifications for the current user with paging and filters for release notes, notices, and operational updates.", "operationId": "Notifications_GetAnnouncements", "requestBody": { "description": "Request data options for pagination, filtering, and sorting.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged notification table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfNotificationTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/notifications/push/installations/current": { "put": { "tags": [ "Notifications" ], "summary": "Register a current-user mobile push installation", "description": "Registers or refreshes the authenticated user's mobile push installation so Leadping can deliver account and workflow notifications to the device.", "operationId": "Notifications_RegisterPushInstallation", "requestBody": { "description": "The application, device, platform, and provider push-channel details to register.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PushInstallationRequest" } ], "description": "Describes a mobile push installation. Identity and Azure tags are derived by the API." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PushInstallationRequest" } ], "description": "Describes a mobile push installation. Identity and Azure tags are derived by the API." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/notifications/push/installations/{installationId}": { "delete": { "tags": [ "Notifications" ], "summary": "Unregister a current-user mobile push installation", "description": "Removes a mobile push installation from the authenticated user's account so Leadping no longer sends notifications to that device.", "operationId": "Notifications_UnregisterPushInstallation", "parameters": [ { "name": "installationId", "in": "path", "description": "The stable mobile installation identifier to unregister.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/outbound/overview": { "get": { "tags": [ "OutboundDelivery" ], "summary": "Get organization outbound delivery overview", "description": "Returns current-organization outbound capacity, scheduled work, and pacing decisions used to control lead communication delivery.", "operationId": "OutboundDelivery_GetCurrentOrganizationOverview", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutboundCapacityOverview" } ], "description": "Summarizes organization-wide SMS and voice sending capacity, phone-number health, and recent outbound pacing decisions." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/sources": { "post": { "tags": [ "Sources" ], "summary": "Create an organization lead intake source", "description": "Creates a lead source for the current organization, storing intake credentials and routing context for captured external leads.", "operationId": "Sources_Create", "requestBody": { "description": "The source data to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceRequest" } ], "description": "Defines the fields clients can send when working with lead source." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceRequest" } ], "description": "Defines the fields clients can send when working with lead source." } } }, "required": true }, "responses": { "201": { "description": "Source was successfully created.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceCredentialIssueResponse" } ], "description": "Returns a newly issued source credential exactly once." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/sources/{id}": { "put": { "tags": [ "Sources" ], "summary": "Update an organization lead intake source", "description": "Updates a lead source for the current organization, changing intake settings, credentials, routing context, or active status.", "operationId": "Sources_Update", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the source to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated source data.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceRequest" } ], "description": "Defines the fields clients can send when working with lead source." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceRequest" } ], "description": "Defines the fields clients can send when working with lead source." } } }, "required": true }, "responses": { "200": { "description": "Source was successfully updated.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceResponse" } ], "description": "Describes lead source data returned by Leadping." } } } }, "404": { "description": "The specified source 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "get": { "tags": [ "Sources" ], "summary": "Get an organization lead intake source by ID", "description": "Returns one lead source for the current organization, including intake settings, credentials metadata, and routing context.", "operationId": "Sources_Get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the source to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Source was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceResponse" } ], "description": "Describes lead source data returned by Leadping." } } } }, "404": { "description": "The specified source 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "delete": { "tags": [ "Sources" ], "summary": "Delete an organization lead intake source", "description": "Deletes a lead source from the current organization so it can no longer accept or route newly captured leads.", "operationId": "Sources_Delete", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the source to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Source was successfully deleted." }, "404": { "description": "The specified source 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/sources/{id}/credentials/rotate": { "post": { "tags": [ "Sources" ], "summary": "Rotate a source intake credential.", "description": "Invalidates the current credential and returns the replacement secret once. Only its hash and short preview are retained.", "operationId": "Sources_RotateApiKey", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the source whose intake credential should be rotated.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceCredentialIssueResponse" } ], "description": "Returns a newly issued source credential exactly once." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/sources/all/my": { "post": { "tags": [ "Sources" ], "summary": "List organization lead intake sources for user", "description": "Lists current-user lead sources with paging, sorting, and filters for intake configuration and routing review.", "operationId": "Sources_GetAllForCurrentUser", "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Sources were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfSourceTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/sources/{id}/metrics": { "get": { "tags": [ "Sources" ], "summary": "Get lead metrics for a source", "description": "View lead creation metrics for an organization intake source, including accepted, rejected, duplicate, validation, and recent activity counts.", "operationId": "Sources_GetMetrics", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the source to retrieve metrics for.", "required": true, "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "description": "Optional start date/time for the metric range.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endAt", "in": "query", "description": "Optional end date/time for the metric range.", "schema": { "type": "string", "format": "date-time" } }, { "name": "days", "in": "query", "description": "Optional rolling day count when explicit dates are not provided.", "schema": { "type": [ "null", "integer" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SourceMetricsResponse" } ], "description": "Aggregates lead volume, conversion, delivery, and activity metrics attributed to a Leadping source over the requested reporting period." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/suppressions": { "post": { "tags": [ "Suppressions" ], "summary": "Create or reactivate a recipient suppression", "description": "The result reflects the effective compliance state after normalization, organization scoping, and suppression-history checks.", "operationId": "Suppressions_Suppress", "requestBody": { "description": "The suppression entry request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryRequest" } ], "description": "Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryRequest" } ], "description": "Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach." } } }, "required": true }, "responses": { "201": { "description": "The suppression entry response was created successfully.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryResponse" } ], "description": "Describes a recipient suppression that prevents outreach through one or more communication channels." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/suppressions/release": { "post": { "tags": [ "Suppressions" ], "summary": "Release an active recipient suppression", "description": "The result reflects the effective compliance state after normalization, organization scoping, and suppression-history checks.", "operationId": "Suppressions_Release", "requestBody": { "description": "The suppression entry request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryRequest" } ], "description": "Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryRequest" } ], "description": "Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach." } } }, "required": true }, "responses": { "200": { "description": "Returns the suppression entry response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryResponse" } ], "description": "Describes a recipient suppression that prevents outreach through one or more communication channels." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/suppressions/check": { "post": { "tags": [ "Suppressions" ], "summary": "Check whether a recipient is suppressed", "description": "The result reflects the effective compliance state after normalization, organization scoping, and suppression-history checks.", "operationId": "Suppressions_Check", "requestBody": { "description": "The suppression entry request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryRequest" } ], "description": "Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryRequest" } ], "description": "Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach." } } }, "required": true }, "responses": { "200": { "description": "Returns the suppression check result.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionCheckResult" } ], "description": "Reports whether Leadping may contact a recipient and identifies the active suppression when contact is blocked." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/suppressions/all/my": { "post": { "tags": [ "Suppressions" ], "summary": "List current-organization suppression entries", "description": "Returns a filtered, paginated list of recipients the current organization has blocked from phone, SMS, or email outreach.", "operationId": "Suppressions_GetAllForCurrentOrganization", "requestBody": { "description": "Pagination, filtering, and sorting options for suppression entries.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfSuppressionEntryResponse" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/suppressions/{id}": { "get": { "tags": [ "Suppressions" ], "summary": "Get an organization suppression entry", "description": "Returns one suppression entry for the current organization, including its recipient, channel, reason, status, and audit timestamps.", "operationId": "Suppressions_Get", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the suppression entry to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryResponse" } ], "description": "Describes a recipient suppression that prevents outreach through one or more communication channels." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/tags": { "get": { "tags": [ "Tags" ], "summary": "List organization lead segmentation tags", "description": "Lists tags for the current organization, optionally including archived tags, for lead segmentation, filters, and routing labels.", "operationId": "Tags_GetAllForCurrentOrganization", "parameters": [ { "name": "includeArchived", "in": "query", "description": "Whether to include tags that are no longer available for new assignments.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/TagResponse" } ], "description": "Describes tag data returned by Leadping." } } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "post": { "tags": [ "Tags" ], "summary": "Create an organization lead segmentation tag", "description": "Creates a tag for the current organization so leads can be segmented, filtered, routed, and reviewed by label.", "operationId": "Tags_Create", "requestBody": { "description": "The tag name, color, and related display settings to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TagRequest" } ], "description": "Defines the fields clients can send when working with tag." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TagRequest" } ], "description": "Defines the fields clients can send when working with tag." } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TagResponse" } ], "description": "Describes tag 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/tags/{id}": { "put": { "tags": [ "Tags" ], "summary": "Update an organization lead segmentation tag", "description": "Updates a current-organization tag's name, color, or archived state so lead segmentation and filters stay consistent.", "operationId": "Tags_Update", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the tag to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The replacement tag name, color, and related display settings.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TagRequest" } ], "description": "Defines the fields clients can send when working with tag." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TagRequest" } ], "description": "Defines the fields clients can send when working with tag." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TagResponse" } ], "description": "Describes tag data returned by Leadping." } } } }, "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." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "delete": { "tags": [ "Tags" ], "summary": "Archive an organization lead segmentation tag", "description": "Archives a tag for the current organization so it stops being used for new segmentation while historical lead labels remain available.", "operationId": "Tags_Archive", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the tag to archive.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/users/me/paymentmethod": { "get": { "tags": [ "Users" ], "summary": "Get current user's billing payment method", "description": "Returns the current user's default payment method details for billing displays and account payment management.", "operationId": "Users_GetPaymentMethodForCurrentUser", "responses": { "200": { "description": "Returns the Stripe payment method response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/StripePaymentMethodResponse" } ], "description": "Describes Stripe payment method data used in Leadping API requests and responses." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/users/me": { "get": { "tags": [ "Users" ], "summary": "Get current user account profile details", "description": "Returns the current user's profile, roles, organization context, billing state, and compliance settings for portal sessions.", "operationId": "Users_GetForCurrentUser", "responses": { "200": { "description": "Returns the user response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserResponse" } ], "description": "Describes user data returned by Leadping." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "put": { "tags": [ "Users" ], "summary": "Update current user account profile", "description": "Updates the current user's profile fields, contact details, preferences, or organization context used across Leadping.", "operationId": "Users_UpdateForCurrentUser", "requestBody": { "description": "The user request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserRequest" } ], "description": "Defines the fields clients can send when working with user profile." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserRequest" } ], "description": "Defines the fields clients can send when working with user profile." } } }, "required": true }, "responses": { "200": { "description": "Returns the user response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserResponse" } ], "description": "Describes user 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/users/me/notification-preferences": { "put": { "tags": [ "Users" ], "summary": "Updates the current user's notification preferences without requiring profile fields.", "description": "Replaces the notification channel and delivery preferences stored for the authenticated user.", "operationId": "Users_UpdateNotificationPreferencesForCurrentUser", "requestBody": { "description": "The notification preferences to store for the current user.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserNotificationPreferences" } ], "description": "Describes user notification preferences data used in Leadping API requests and responses." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserNotificationPreferences" } ], "description": "Describes user notification preferences data used in Leadping API requests and responses." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserResponse" } ], "description": "Describes user 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/users/change-billing-plan": { "put": { "tags": [ "Users" ], "summary": "Change the current user's billing plan", "description": "Changes the current user's billing plan selection, updating account billing state and plan-specific capabilities.", "operationId": "Users_ChangeBillingPlan", "requestBody": { "description": "The change billing plan request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangeBillingPlanRequest" } ], "description": "Defines the input used for change billing plan." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangeBillingPlanRequest" } ], "description": "Defines the input used for change billing plan." } } }, "required": true }, "responses": { "200": { "description": "Returns the user response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserResponse" } ], "description": "Describes user 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." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/users/compliance": { "put": { "tags": [ "Users" ], "summary": "Update current user compliance settings", "description": "Updates current-user compliance settings used for messaging eligibility, billing readiness, and organization account setup.", "operationId": "Users_UpdateCompliance", "requestBody": { "description": "The compliance update request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ComplianceUpdateRequest" } ], "description": "Defines the input used for compliance update." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ComplianceUpdateRequest" } ], "description": "Defines the input used for compliance update." } } }, "required": true }, "responses": { "200": { "description": "Returns the user response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserResponse" } ], "description": "Describes user 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-call/initiate": { "post": { "tags": [ "Calls" ], "summary": "Initiate a Leadping phone call", "description": "The call operation validates ownership and current provider state before returning the updated Leadping call representation.", "operationId": "Calls_InitiateCall", "requestBody": { "description": "The call initiation request containing phone number and optional metadata.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateCallRequest" } ], "description": "Defines the fields clients can send when working with phone call initiation." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateCallRequest" } ], "description": "Defines the fields clients can send when working with phone call initiation." } } }, "required": true }, "responses": { "200": { "description": "Calls was successfully initiated.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneCallResponse" } ], "description": "Describes a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-call/{callId}/hangup": { "post": { "tags": [ "Calls" ], "summary": "End an active Leadping phone call", "description": "The call operation validates ownership and current provider state before returning the updated Leadping call representation.", "operationId": "Calls_HangupCall", "parameters": [ { "name": "callId", "in": "path", "description": "The unique identifier of the call to end.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Calls was successfully ended.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneCallResponse" } ], "description": "Describes a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details." } } } }, "400": { "description": "The request was invalid or malformed.", "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." } } } }, "404": { "description": "The specified call 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-call/{callId}/status": { "get": { "tags": [ "Calls" ], "summary": "Get the status of a Leadping phone call", "description": "The call operation validates ownership and current provider state before returning the updated Leadping call representation.", "operationId": "Calls_GetCallStatus", "parameters": [ { "name": "callId", "in": "path", "description": "The unique identifier of the call to check.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Calls status was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneCallResponse" } ], "description": "Describes a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/phone-call/{callId}/transfer": { "post": { "tags": [ "Calls" ], "summary": "Transfer an active Leadping phone call", "description": "The call operation validates ownership and current provider state before returning the updated Leadping call representation.", "operationId": "Calls_TransferCall", "parameters": [ { "name": "callId", "in": "path", "description": "The unique identifier of the call to transfer.", "required": true, "schema": { "type": "string" } }, { "name": "newPhoneNumber", "in": "query", "description": "The phone number to transfer the call to.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Calls was successfully transferred.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneCallResponse" } ], "description": "Describes a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details." } } } }, "400": { "description": "The request was invalid or malformed.", "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." } } } }, "404": { "description": "The specified call 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/search": { "post": { "tags": [ "PhoneNumbers" ], "summary": "Search purchasable organization phone numbers", "description": "Searches available phone numbers for purchase, applying country, area, and capability filters for lead communication setup.", "operationId": "PhoneNumbers_Search", "requestBody": { "description": "Area code, locality, capabilities, and quantity filters for available phone numbers.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberSearchRequest" } ], "description": "Defines the fields clients can send when working with phone number search." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberSearchRequest" } ], "description": "Defines the fields clients can send when working with phone number search." } } }, "required": true }, "responses": { "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "200": { "description": "Returns the phone number search response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberSearchResponse" } ], "description": "Describes phone number search data returned by Leadping." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/all/organization": { "post": { "tags": [ "PhoneNumbers" ], "summary": "List current-organization phone numbers", "description": "Lists phone numbers visible to the current organization with paging, sorting, and filters for messaging, calling, and warmup management.", "operationId": "PhoneNumbers_GetAllForCurrentOrganization", "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Phone numbers were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfPhoneNumberTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/outgoing/conversation/{conversationId}": { "post": { "tags": [ "PhoneNumbers" ], "summary": "Select conversation sender number", "description": "Selects the outgoing phone number for an existing conversation, considering assignments, overrides, and delivery eligibility.", "operationId": "PhoneNumbers_GetOutgoingForConversation", "parameters": [ { "name": "conversationId", "in": "path", "description": "The conversation identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The outgoing number selection request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionRequest" } ], "description": "Defines the fields clients can send when working with outgoing number selection." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionRequest" } ], "description": "Defines the fields clients can send when working with outgoing number selection." } } }, "required": true }, "responses": { "200": { "description": "Returns the outgoing number selection response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionResponse" } ], "description": "Describes outgoing number selection 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/outgoing/new": { "post": { "tags": [ "PhoneNumbers" ], "summary": "Select new lead sender number", "description": "Selects an outgoing phone number for a new outbound lead message using destination, source, and delivery eligibility rules.", "operationId": "PhoneNumbers_GetOutgoingForNewOutbound", "requestBody": { "description": "The outgoing number selection request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionRequest" } ], "description": "Defines the fields clients can send when working with outgoing number selection." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionRequest" } ], "description": "Defines the fields clients can send when working with outgoing number selection." } } }, "required": true }, "responses": { "200": { "description": "Returns the outgoing number selection response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionResponse" } ], "description": "Describes outgoing number selection 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/outgoing/manual-override": { "post": { "tags": [ "PhoneNumbers" ], "summary": "Validate sender number override", "description": "Validates a manual outgoing-number override before use, checking ownership, destination, and delivery eligibility.", "operationId": "PhoneNumbers_ValidateManualOverride", "requestBody": { "description": "The outgoing number manual override request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberManualOverrideRequest" } ], "description": "Defines the fields clients can send when working with outgoing number manual override." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberManualOverrideRequest" } ], "description": "Defines the fields clients can send when working with outgoing number manual override." } } }, "required": true }, "responses": { "200": { "description": "Returns the outgoing number selection response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionResponse" } ], "description": "Describes outgoing number selection 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/outgoing/conversation/{conversationId}/override": { "post": { "tags": [ "PhoneNumbers" ], "summary": "Set sender number override", "description": "Sets the outgoing phone number override for a conversation so future lead messages use the selected eligible number.", "operationId": "PhoneNumbers_SetConversationOverride", "parameters": [ { "name": "conversationId", "in": "path", "description": "The conversation identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The outgoing number manual override request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberManualOverrideRequest" } ], "description": "Defines the fields clients can send when working with outgoing number manual override." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberManualOverrideRequest" } ], "description": "Defines the fields clients can send when working with outgoing number manual override." } } }, "required": true }, "responses": { "200": { "description": "Returns the outgoing number selection response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionResponse" } ], "description": "Describes outgoing number selection 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "delete": { "tags": [ "PhoneNumbers" ], "summary": "Clear sender number override", "description": "Clears a conversation's outgoing-number override so future lead messages return to automatic number selection.", "operationId": "PhoneNumbers_ClearConversationOverride", "parameters": [ { "name": "conversationId", "in": "path", "description": "The conversation identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the outgoing number selection response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionResponse" } ], "description": "Describes outgoing number selection 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/{phoneNumberId}": { "get": { "tags": [ "PhoneNumbers" ], "summary": "Get organization phone number details by ID", "description": "Returns one phone number visible to the current user, including messaging status, assignment, warmup, and purchase metadata.", "operationId": "PhoneNumbers_Get", "parameters": [ { "name": "phoneNumberId", "in": "path", "description": "The phone number identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the phone number response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberResponse" } ], "description": "Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "put": { "tags": [ "PhoneNumbers" ], "summary": "Update organization phone number settings", "description": "Updates phone number settings such as its optional label, assignment, messaging options, or warmup configuration.", "operationId": "PhoneNumbers_Update", "parameters": [ { "name": "phoneNumberId", "in": "path", "description": "The ID of the phone number to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated phone number details.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberRequest" } ], "description": "Defines the fields clients can send when working with phone number update." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberRequest" } ], "description": "Defines the fields clients can send when working with phone number update." } } }, "required": true }, "responses": { "200": { "description": "Returns the phone number response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberResponse" } ], "description": "Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details." } } } }, "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." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "delete": { "tags": [ "PhoneNumbers" ], "summary": "Delete an organization phone number by ID", "description": "Deletes a phone number from the current organization when it should no longer be used for lead communication.", "operationId": "PhoneNumbers_Delete", "parameters": [ { "name": "phoneNumberId", "in": "path", "description": "The ID of the phone number to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content is returned when the operation succeeds." }, "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." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers": { "post": { "tags": [ "PhoneNumbers" ], "summary": "Create an organization phone number for messaging", "description": "Purchases or creates a phone number for the current organization so it can be assigned to messaging, calls, and lead follow-up.", "operationId": "PhoneNumbers_Create", "requestBody": { "description": "The phone number details to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberRequest" } ], "description": "Defines the fields clients can send when working with phone number update." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberRequest" } ], "description": "Defines the fields clients can send when working with phone number update." } } }, "required": true }, "responses": { "200": { "description": "Returns the phone number response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberResponse" } ], "description": "Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/phone-numbers/{phoneNumber}/status": { "get": { "tags": [ "PhoneNumbers" ], "summary": "Get organization phone number provider status", "description": "Returns provider and Leadping status for a phone number, including messaging warmup, assignments, and verification state.", "operationId": "PhoneNumbers_GetStatus", "parameters": [ { "name": "phoneNumber", "in": "path", "description": "The phone number to check the status for.", "required": true, "schema": { "type": "string" } }, { "name": "windowDays", "in": "query", "description": "The window days.", "schema": { "type": [ "null", "integer" ], "format": "int32" } }, { "name": "startDate", "in": "query", "description": "The start date.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date.", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Phone number status was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberStatusResponse" } ], "description": "Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic." } } } }, "400": { "description": "The request was invalid or malformed.", "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." } } } }, "500": { "description": "An internal server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/phone-numbers/{phoneNumberId}/warmup": { "get": { "tags": [ "PhoneNumbers" ], "summary": "Get organization phone number warmup status", "description": "Returns warmup status for a phone number, including limits and recent events used for delivery pacing.", "operationId": "PhoneNumbers_GetWarmupStatus", "parameters": [ { "name": "phoneNumberId", "in": "path", "description": "The phone number identifier.", "required": true, "schema": { "type": "string" } }, { "name": "windowDays", "in": "query", "description": "The window days.", "schema": { "type": [ "null", "integer" ], "format": "int32" } }, { "name": "startDate", "in": "query", "description": "The start date.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date.", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Returns the phone number status response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberStatusResponse" } ], "description": "Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/phone-numbers/is-available-for-purchase": { "post": { "tags": [ "PhoneNumbers" ], "summary": "Check phone number purchase availability", "description": "Checks whether a phone number can be purchased for the current organization before creating or assigning it.", "operationId": "PhoneNumbers_IsAvailableForPurchase", "requestBody": { "description": "The phone number availability request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberAvailabilityRequest" } ], "description": "Defines the phone number and capability requirements Leadping should verify before purchase or assignment." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberAvailabilityRequest" } ], "description": "Defines the phone number and capability requirements Leadping should verify before purchase or assignment." } } }, "required": true }, "responses": { "200": { "description": "Returns the phone number availability response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberAvailabilityResponse" } ], "description": "Reports whether a phone number is available for purchase or assignment and explains any blocking condition." } } } }, "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." } } } }, "500": { "description": "An unexpected server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/sms/send": { "post": { "tags": [ "Sms" ], "summary": "Send an SMS message to an organization lead", "description": "Sends an SMS message to a lead or phone number, applying current-organization sender selection, scheduling, and delivery rules.", "operationId": "Sms_Send", "requestBody": { "description": "The SMS request containing recipient and message details.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SendSmsRequest" } ], "description": "Defines the fields clients can send when working with SMS send." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SendSmsRequest" } ], "description": "Defines the fields clients can send when working with SMS send." } } }, "required": true }, "responses": { "201": { "description": "The SMS response was created successfully.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SmsResponse" } ], "description": "Describes an SMS or MMS message, including participants, delivery state, scheduling, media, and billing details." } } } }, "400": { "description": "The request was invalid or malformed.", "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." } } } }, "500": { "description": "An internal server error occurred.", "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": "Internal Server Error", "status": 500, "detail": "The request could not be completed." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true }, "reversibility": { "supported": "conditional", "operation-id": "Sms_CancelScheduled", "window": "While the SMS status is Scheduled and before delivery begins." } } } }, "/sms/media": { "post": { "tags": [ "Sms" ], "summary": "Upload media for an MMS message", "description": "Uploads and validates one media attachment, returning the metadata needed to include the asset in a subsequent Leadping MMS send.", "operationId": "Sms_UploadMedia", "requestBody": { "description": "The image or media file to validate and upload for a subsequent MMS message.", "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "Binary file content to upload.", "format": "binary" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MessageMediaAttachment" } ], "description": "Media attached to an SMS/MMS conversation event." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MessageMediaAttachment" } ], "description": "Media attached to an SMS/MMS conversation event." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MessageMediaAttachment" } ], "description": "Media attached to an SMS/MMS conversation event." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/sms/{smsEventId}/cancel": { "post": { "tags": [ "Sms" ], "summary": "Cancel a scheduled SMS message for a lead", "description": "Cancels a scheduled SMS event before delivery, preserving the event record while preventing the queued message from being sent.\nThe cancellation window remains open only while the SMS status is Scheduled and closes when delivery begins.", "operationId": "Sms_CancelScheduled", "parameters": [ { "name": "smsEventId", "in": "path", "description": "The SMS event identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the SMS response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SmsResponse" } ], "description": "Describes an SMS or MMS message, including participants, delivery state, scheduling, media, and billing details." } } } }, "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." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/telephony/login": { "post": { "tags": [ "Telephony" ], "summary": "Generate a WebRTC login token", "description": "The issued client configuration is scoped to the authenticated user and contains only the short-lived credentials required by the calling client.", "operationId": "Telephony_Login", "requestBody": { "description": "The telephony login request containing connection details.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TelephonyLoginRequest" } ], "description": "Identifies the Leadping user and calling context for which a short-lived telephony client token should be issued." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TelephonyLoginRequest" } ], "description": "Identifies the Leadping user and calling context for which a short-lived telephony client token should be issued." } } }, "required": true }, "responses": { "200": { "description": "Login token was successfully generated.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TelephonyLoginResponse" } ], "description": "Provides the short-lived access token and client configuration required to initialize an authenticated Leadping calling session." } } } }, "400": { "description": "The request was invalid or malformed.", "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": "The user is not authenticated.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me": { "get": { "tags": [ "Organizations" ], "summary": "Get current organization account profile", "description": "Returns the authenticated user's current organization profile, including account settings, billing context, and communication configuration.", "operationId": "Organizations_GetForCurrentUser", "responses": { "200": { "description": "Organization was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Describes organization profile data returned by Leadping." } } } }, "404": { "description": "The specified organization 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "post": { "tags": [ "Organizations" ], "summary": "Create an organization account", "description": "Creates an organization account for the authenticated user, assigns them as its owner, and makes it their active organization context.", "operationId": "Organizations_CreateForCurrentUser", "requestBody": { "description": "The organization profile, contact, and initial setup details to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationRequest" } ], "description": "Defines the fields clients can send when working with organization profile." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationRequest" } ], "description": "Defines the fields clients can send when working with organization profile." } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Describes organization profile 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "put": { "tags": [ "Organizations" ], "summary": "Update current organization account profile", "description": "Updates the authenticated user's current organization profile, including contact, settings, and communication configuration.", "operationId": "Organizations_UpdateForCurrentUser", "requestBody": { "description": "The updated organization profile data.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationRequest" } ], "description": "Defines the fields clients can send when working with organization profile." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationRequest" } ], "description": "Defines the fields clients can send when working with organization profile." } } }, "required": true }, "responses": { "200": { "description": "Returns the organization response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Describes organization profile 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/options": { "get": { "tags": [ "Organizations" ], "summary": "List organization switch options", "description": "Lists organizations the authenticated user can switch into, including membership role and current-organization selection data.", "operationId": "Organizations_GetSwitchOptions", "responses": { "200": { "description": "Returns the list of organization switch option.", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/OrganizationSwitchOption" } ], "description": "Describes organization switch option data used in Leadping API requests and responses." } } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/organizations/me/switch": { "post": { "tags": [ "Organizations" ], "summary": "Switch current organization account context", "description": "Switches the authenticated user's active organization context so subsequent lead, billing, and communication requests target that organization.", "operationId": "Organizations_SwitchCurrentOrganization", "requestBody": { "description": "The selected organization identifier.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationSwitchRequest" } ], "description": "Defines the fields clients can send when working with organization switch." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationSwitchRequest" } ], "description": "Defines the fields clients can send when working with organization switch." } } }, "required": true }, "responses": { "200": { "description": "Returns the organization response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Describes organization profile data returned by Leadping." } } } }, "403": { "description": "The authenticated user is not authorized for 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/members": { "get": { "tags": [ "Organizations" ], "summary": "List users for the current organization", "description": "Lists users assigned to the current organization, including roles and membership details for access management.", "operationId": "Organizations_GetCurrentOrganizationMembers", "responses": { "200": { "description": "Returns the list of organization member table row.", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberTableRow" } ], "description": "Describes organization user data used in Leadping API requests and responses." } } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "post": { "tags": [ "Organizations" ], "summary": "Add a user to the current organization account", "description": "Adds an existing user to the current organization with the requested role for shared lead communication and account access.", "operationId": "Organizations_AddCurrentOrganizationMember", "requestBody": { "description": "The user and role to add to the current organization.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRequest" } ], "description": "Defines the fields clients can send when working with organization user." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRequest" } ], "description": "Defines the fields clients can send when working with organization user." } } }, "required": true }, "responses": { "200": { "description": "Returns the organization member response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberResponse" } ], "description": "Describes organization user 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." } } } }, "403": { "description": "The authenticated user is not authorized for 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/members/{userId}": { "put": { "tags": [ "Organizations" ], "summary": "Change a current-organization user role", "description": "Changes a user's role in the current organization, updating access to lead, automation, billing, and admin workflows.", "operationId": "Organizations_ChangeCurrentOrganizationMemberRole", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the user whose current-organization role is changing.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated role assignment.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRequest" } ], "description": "Defines the fields clients can send when working with organization user." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRequest" } ], "description": "Defines the fields clients can send when working with organization user." } } }, "required": true }, "responses": { "200": { "description": "Returns the organization member response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberResponse" } ], "description": "Describes organization user 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." } } } }, "403": { "description": "The authenticated user is not authorized for 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "delete": { "tags": [ "Organizations" ], "summary": "Remove a user from the current organization", "description": "Removes a user from the current organization, revoking their access to its leads, settings, billing, and communication data.", "operationId": "Organizations_RemoveCurrentOrganizationMember", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the user to remove from the current organization.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content is returned when the operation succeeds." }, "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." } } } }, "403": { "description": "The authenticated user is not authorized for 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/membership": { "delete": { "tags": [ "Organizations" ], "summary": "Leave the current organization without changing its subscription or deleting organization data.", "description": "Removes the authenticated user's membership from the current organization while preserving the organization and its billing state.", "operationId": "Organizations_LeaveCurrentOrganization", "responses": { "204": { "description": "No Content" }, "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." } } } }, "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." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/invitations": { "get": { "tags": [ "Organizations" ], "summary": "List invitations for the current organization", "description": "Lists pending and historical invitations for the current organization, including recipient, role, status, and expiration.", "operationId": "Organizations_GetCurrentOrganizationInvitations", "responses": { "200": { "description": "Returns the list of organization invitation table row.", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationTableRow" } ], "description": "Describes organization invitation data used in Leadping API requests and responses." } } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "post": { "tags": [ "Organizations" ], "summary": "Create a current-organization user invitation", "description": "Creates an invitation for the current organization so another user can join with the requested role and account access.", "operationId": "Organizations_CreateCurrentOrganizationInvitation", "requestBody": { "description": "The invitation recipient and requested role.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationRequest" } ], "description": "Defines the input used for organization invitation." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationRequest" } ], "description": "Defines the input used for organization invitation." } } }, "required": true }, "responses": { "200": { "description": "Returns the organization invitation response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationResponse" } ], "description": "Describes organization invitation 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/invitations/{invitationId}/resend": { "post": { "tags": [ "Organizations" ], "summary": "Resend a current-organization user invitation", "description": "Resends a pending current-organization invitation, refreshing delivery while preserving recipient, role, and acceptance token.", "operationId": "Organizations_ResendCurrentOrganizationInvitation", "parameters": [ { "name": "invitationId", "in": "path", "description": "The ID of the current-organization invitation to resend.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the organization invitation response.", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationResponse" } ], "description": "Describes organization invitation data returned by Leadping." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationResponse" } ], "description": "Describes organization invitation data returned by Leadping." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationResponse" } ], "description": "Describes organization invitation 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/invitations/{invitationId}": { "delete": { "tags": [ "Organizations" ], "summary": "Revoke a current-organization user invitation", "description": "Revokes a pending current-organization invitation so the recipient can no longer use it to join the organization.", "operationId": "Organizations_RevokeCurrentOrganizationInvitation", "parameters": [ { "name": "invitationId", "in": "path", "description": "The ID of the current-organization invitation to revoke.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content is returned when the operation succeeds." }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/me/10dlc/notes": { "put": { "tags": [ "Organizations" ], "summary": "Update organization 10DLC notes", "description": "Updates the shared 10DLC registration notes for the current organization, keeping carrier review context and messaging compliance details current.", "operationId": "Organizations_UpdateCurrentOrganizationTenDlcNotes", "requestBody": { "description": "The replacement 10DLC registration and carrier-review notes.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenDlcNotesRequest" } ], "description": "Updates the internal notes associated with a 10DLC application." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenDlcNotesRequest" } ], "description": "Updates the internal notes associated with a 10DLC application." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Describes organization profile 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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/api-keys/my": { "post": { "tags": [ "Organizations" ], "summary": "List current-organization API keys", "description": "The operation enforces organization ownership or platform-admin authorization and returns state suitable for membership, billing, and support workflows.", "operationId": "Organizations_GetAllApiKeysForCurrentUser", "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Current-organization API keys were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyListResponse" } ], "description": "A page of safe organization API-key previews." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/organizations/api-keys/{id}": { "get": { "tags": [ "Organizations" ], "summary": "Gets a safe API key detail row for a key the caller can access.", "description": "The operation enforces organization ownership or platform-admin authorization and returns state suitable for membership, billing, and support workflows.", "operationId": "Organizations_GetApiKey", "parameters": [ { "name": "id", "in": "path", "description": "The API key ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The API key detail was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyPreviewResponse" } ], "description": "Safe identifying and usage metadata for an organization API key. This model never contains the secret credential." } } } }, "404": { "description": "The API key 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "post": { "tags": [ "Organizations" ], "summary": "Creates an organization-owned API key.", "description": "The operation enforces organization ownership or platform-admin authorization and returns state suitable for membership, billing, and support workflows.", "operationId": "Organizations_IssueApiKey", "parameters": [ { "name": "id", "in": "path", "description": "The organization ID that will own the API key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The key expiration selection. Null expiration means no limit.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyRequest" } ], "description": "Defines the display name and access configuration for a new Leadping organization API key." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyRequest" } ], "description": "Defines the display name and access configuration for a new Leadping organization API key." } } }, "required": true }, "responses": { "200": { "description": "The API key was created successfully.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyIssueResponse" } ], "description": "Returns a newly issued organization API key and its identifying metadata; the secret credential is shown only in this response." } } } }, "400": { "description": "The request was invalid.", "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." } } } }, "403": { "description": "The caller cannot manage this organization API key.", "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } }, "delete": { "tags": [ "Organizations" ], "summary": "Deletes an organization-owned API key without deleting the organization.", "description": "The operation enforces organization ownership or platform-admin authorization and returns state suitable for membership, billing, and support workflows.", "operationId": "Organizations_DeleteApiKey", "parameters": [ { "name": "id", "in": "path", "description": "The API key ID to revoke.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The API key was successfully revoked.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyRevokeResponse" } ], "description": "Confirms that an organization API key was revoked." } } } }, "404": { "description": "The API key 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/reports/exports/my": { "post": { "tags": [ "UserDataExports" ], "summary": "Request a current-user data export report", "description": "Requests a data export for the current user, starting asynchronous report generation for account, lead, and event records.", "operationId": "UserDataExports_RequestCurrentUser", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDataExportResponse" } ], "description": "Describes the lifecycle, scope, progress, retention, and downloadable artifacts of a Leadping user-data export request." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/reports/exports/{exportId}": { "get": { "tags": [ "UserDataExports" ], "summary": "Get a current-user data export report", "description": "Returns the status and metadata for one current-user data export, including readiness, expiration, and download availability.", "operationId": "UserDataExports_GetCurrentUserExport", "parameters": [ { "name": "exportId", "in": "path", "description": "The unique identifier of the current user's data export.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDataExportResponse" } ], "description": "Describes the lifecycle, scope, progress, retention, and downloadable artifacts of a Leadping user-data export request." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/reports/exports/{exportId}/download": { "get": { "tags": [ "UserDataExports" ], "summary": "Download a current-user data export report", "description": "Validates an export download token and redirects to the generated file when the current-user report is ready.", "operationId": "UserDataExports_Download", "parameters": [ { "name": "exportId", "in": "path", "description": "The unique identifier of the data export to download.", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "The short-lived download token issued for this export.", "required": true, "schema": { "type": "string" } }, { "name": "redirect", "in": "query", "description": "Whether to redirect to the temporary file URL. Set to false to return the URL as JSON.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDataExportDownloadResponse" } ], "description": "Provides the temporary download location and expiration details for a completed Leadping user-data export." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDataExportDownloadResponse" } ], "description": "Provides the temporary download location and expiration details for a completed Leadping user-data export." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDataExportDownloadResponse" } ], "description": "Provides the temporary download location and expiration details for a completed Leadping user-data export." } } } }, "302": { "description": "Found" }, "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." } } } }, "410": { "description": "Gone", "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": "Gone", "status": 410, "detail": "The request could not be completed." } } } }, "429": { "description": "Too Many Requests", "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": [ ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": false }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/events/calls/all/my": { "post": { "tags": [ "CallEvents" ], "summary": "List current-user lead call event history", "description": "Lists call events visible to the current user with paging, sorting, and filters for call history and lead follow-up review.", "operationId": "CallEvents_GetAllForCurrentUser", "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Call events were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfCallEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/calls/{callEventId}": { "get": { "tags": [ "CallEvents" ], "summary": "Get lead call event details by event ID", "description": "Returns one call event, including call metadata, provider status, related lead, and communication context.", "operationId": "CallEvents_GetById", "parameters": [ { "name": "callEventId", "in": "path", "description": "The ID of the call event to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the call event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CallEventTableRow" } ], "description": "Summarizes call event data in paginated and searchable results." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/events/calls/lead/{leadId}": { "post": { "tags": [ "CallEvents" ], "summary": "List call event history for an organization lead", "description": "Lists call events for one lead with paging, helping users review call attempts, outcomes, and follow-up history.", "operationId": "CallEvents_GetByLeadId", "parameters": [ { "name": "leadId", "in": "path", "description": "The ID of the lead.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged call event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfCallEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/calls/phone/{phoneNumber}": { "post": { "tags": [ "CallEvents" ], "summary": "List call event history for a phone number", "description": "Lists call events for one phone number with paging, helping users review volume, outcomes, and communication history.", "operationId": "CallEvents_GetByPhoneNumber", "parameters": [ { "name": "phoneNumber", "in": "path", "description": "The phone number to search for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged call event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfCallEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/all/my": { "post": { "tags": [ "Events" ], "summary": "List current-user lead events", "description": "Lists event records visible to the current user with paging, sorting, and filters across lead, SMS, call, and automation events.", "operationId": "Events_GetAllForCurrentUser", "parameters": [ { "name": "category", "in": "query", "description": "Optional event category used to narrow the results.", "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "description": "Optional inclusive start timestamp for event occurrence.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endAt", "in": "query", "description": "Optional exclusive end timestamp for event occurrence.", "schema": { "type": "string", "format": "date-time" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Events were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/organizations/{organizationId}": { "post": { "tags": [ "Events" ], "summary": "List organization lead event history", "description": "Lists event records for an organization with paging and filters so admins can review lead communication and automation events.", "operationId": "Events_GetAllForOrganization", "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization identifier.", "required": true, "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "description": "Optional inclusive start timestamp for event occurrence.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endAt", "in": "query", "description": "Optional exclusive end timestamp for event occurrence.", "schema": { "type": "string", "format": "date-time" } } ], "requestBody": { "description": "The filtering, sorting, and pagination options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/conversations/{conversationId}": { "post": { "tags": [ "Events" ], "summary": "List a conversation's event history", "description": "Lists event records for one conversation with paging, including notes, messages, calls, and follow-up history.", "operationId": "Events_GetAllForConversation", "parameters": [ { "name": "conversationId", "in": "path", "description": "The ID of the conversation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Events for the conversation were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/leads/{leadId}": { "post": { "tags": [ "Events" ], "summary": "List event history for a lead", "description": "Lists event records for one lead with paging, covering communication, routing, automation, and event changes.", "operationId": "Events_GetAllForLead", "parameters": [ { "name": "leadId", "in": "path", "description": "The ID of the lead.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Events for the lead were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/{eventId}": { "get": { "tags": [ "Events" ], "summary": "Get lead event details by ID", "description": "Returns one event record by ID, including event type, timestamps, related entities, and summary payload data.", "operationId": "Events_GetById", "parameters": [ { "name": "eventId", "in": "path", "description": "The ID of the event.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Event was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EventTableRow" } ], "description": "Summarizes event timeline data in paginated and searchable results." } } } }, "404": { "description": "Event 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/events/detail/{eventId}": { "get": { "tags": [ "Events" ], "summary": "Get full lead event payload by ID", "description": "Returns detailed event data by ID, including the full JSON payload for debugging, audit review, and workflow inspection.", "operationId": "Events_GetDetailById", "parameters": [ { "name": "eventId", "in": "path", "description": "The ID of the event.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Event details were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EventDetailResponse" } ], "description": "Describes event detail data returned by Leadping." } } } }, "404": { "description": "Event 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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/events/conversations/{conversationId}/notes": { "post": { "tags": [ "Events" ], "summary": "Add a note to a conversation", "description": "Creates a note event on a conversation so users can document lead context, handoffs, and follow-up details.", "operationId": "Events_CreateNote", "parameters": [ { "name": "conversationId", "in": "path", "description": "The conversation identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The create note request payload for the operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateNoteRequest" } ], "description": "Defines the input used for create note." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateNoteRequest" } ], "description": "Defines the input used for create note." } } }, "required": true }, "responses": { "200": { "description": "Returns the event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EventTableRow" } ], "description": "Summarizes event timeline data in paginated and searchable results." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/sms/all/my": { "post": { "tags": [ "SmsEvents" ], "summary": "List current-user lead SMS event history", "description": "Lists SMS events visible to the current user with paging, sorting, and filters for message history and follow-up review.", "operationId": "SmsEvents_GetAllForCurrentUser", "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "SMS events were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfSmsEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/sms/{smsEventId}": { "get": { "tags": [ "SmsEvents" ], "summary": "Get lead SMS event details by event ID", "description": "Returns one SMS event, including message metadata, provider status, related lead, and delivery context.", "operationId": "SmsEvents_GetById", "parameters": [ { "name": "smsEventId", "in": "path", "description": "The ID of the SMS event to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the SMS event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SmsEventTableRow" } ], "description": "Summarizes SMS event data in paginated and searchable results." } } } }, "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." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/events/sms/lead/{leadId}": { "post": { "tags": [ "SmsEvents" ], "summary": "List message event history for a lead", "description": "Lists SMS events for one lead with paging, helping users review sent messages, scheduled messages, and delivery outcomes.", "operationId": "SmsEvents_GetByLeadId", "parameters": [ { "name": "leadId", "in": "path", "description": "The ID of the lead.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged SMS event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfSmsEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/events/sms/phone/{phoneNumber}": { "post": { "tags": [ "SmsEvents" ], "summary": "List SMS event history for a phone number", "description": "Lists SMS events for one phone number with paging, helping users review volume, delivery outcomes, and communication history.", "operationId": "SmsEvents_GetByPhoneNumber", "parameters": [ { "name": "phoneNumber", "in": "path", "description": "The phone number to search for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged SMS event table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfSmsEventTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/payment-methods": { "get": { "tags": [ "PaymentMethods" ], "summary": "List payment methods", "description": "Lists the payment methods available to the current organization for billing, invoice payments, and wallet funding.", "operationId": "PaymentMethods_GetAll", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/StripePaymentMethodResponse" } ], "description": "Describes Stripe payment method data used in Leadping API requests and responses." } } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/payment-methods/invoices": { "get": { "tags": [ "PaymentMethods" ], "summary": "List current-organization Stripe invoices", "description": "Returns the current organization's Stripe invoices with their amounts, payment status, billing period, and hosted invoice details.", "operationId": "PaymentMethods_GetInvoices", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/StripeInvoiceResponse" } ], "description": "Customer-safe Leadping invoice summary for billing." } } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/payment-methods/invoices/{invoiceId}/pdf-access": { "get": { "tags": [ "PaymentMethods" ], "summary": "Get invoice PDF access", "description": "Creates a short-lived, secure URL that lets the current organization view or download a private Stripe invoice PDF without exposing a permanent file link.", "operationId": "PaymentMethods_GetInvoicePdfAccess", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The Stripe invoice identifier whose PDF should be accessed.", "required": true, "schema": { "type": "string" } }, { "name": "download", "in": "query", "description": "Whether the secure URL should download the PDF instead of displaying it inline.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InvoicePdfAccessResponse" } ], "description": "Short-lived access details for a private Leadping invoice PDF." } } } }, "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." } } } }, "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/payment-methods/{id}": { "get": { "tags": [ "PaymentMethods" ], "summary": "Get an organization billing payment method", "description": "Returns one payment method for the current user or organization, including card metadata used for billing management.", "operationId": "PaymentMethods_Get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the payment method to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment method was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/StripePaymentMethodResponse" } ], "description": "Describes Stripe payment method data used in Leadping API requests and responses." } } } }, "404": { "description": "The specified payment method 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." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } }, "delete": { "tags": [ "PaymentMethods" ], "summary": "Delete an organization billing payment method", "description": "Deletes a payment method so it is no longer available for wallet funding, invoices, or billing account management.", "operationId": "PaymentMethods_Delete", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the payment method to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Payment method was successfully deleted.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified payment method 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." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "safety-critical" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/payment-methods/{id}/default": { "post": { "tags": [ "PaymentMethods" ], "summary": "Set default payment method", "description": "Sets a payment method as the default for the current organization's future invoices and billing activity.", "operationId": "PaymentMethods_MakeDefault", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the payment method to make the default.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/StripePaymentMethodResponse" } ], "description": "Describes Stripe payment method data used in Leadping API requests and responses." } } } }, "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/transactions/{id}": { "get": { "tags": [ "Transactions" ], "summary": "Get a current-user billing transaction", "description": "Returns one transaction visible to the current user, including amount, status, wallet context, and billing metadata.", "operationId": "Transactions_GetForCurrentUser", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the transaction to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transaction was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TransactionResponse" } ], "description": "Describes billing transaction data returned by Leadping." } } } }, "404": { "description": "The specified transaction 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." } } } }, "401": { "description": "The user does not own this transaction.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/transactions/all/my": { "post": { "tags": [ "Transactions" ], "summary": "List current-user billing transactions", "description": "Lists current-user transactions with paging, sorting, and filters for wallet events, billing history, and reconciliation.", "operationId": "Transactions_GetAllForCurrentUser", "parameters": [ { "name": "startAt", "in": "query", "description": "Optional inclusive start timestamp for transaction creation.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endAt", "in": "query", "description": "Optional exclusive end timestamp for transaction creation.", "schema": { "type": "string", "format": "date-time" } } ], "requestBody": { "description": "Pagination, filtering, and sorting options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Transactions were successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfTransactionTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/usage/all/my": { "post": { "tags": [ "Usage" ], "summary": "List organization messaging usage ledger entries", "description": "Lists current-organization usage ledger entries with paging, sorting, and filters for messaging, billing, and wallet review.", "operationId": "Usage_GetAllForCurrentOrganization", "requestBody": { "description": "The filtering, sorting, and pagination options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDataOptions" } ], "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." } } }, "required": true }, "responses": { "200": { "description": "Returns the paged usage ledger table row.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedResultOfUsageLedgerTableRow" } ], "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "acting", "consequences": [ "write" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": true } } } }, "/usage/summary/my": { "get": { "tags": [ "Usage" ], "summary": "Get organization messaging usage summary", "description": "Returns current-organization usage totals for the active billing period, including spend, limits, and event summary data.", "operationId": "Usage_GetSummaryForCurrentOrganization", "parameters": [ { "name": "periodStart", "in": "query", "description": "The period start.", "schema": { "type": "string", "format": "date-time" } }, { "name": "periodEnd", "in": "query", "description": "The period end.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Returns the usage summary response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UsageSummaryResponse" } ], "description": "Describes usage summary response data used by Leadping." } } } }, "401": { "description": "Authentication credentials are missing or invalid.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/wallets/{id}": { "get": { "tags": [ "Wallets" ], "summary": "Get an organization wallet balance by ID", "description": "Returns one wallet by ID, including balance, billing context, and funding status for account payment workflows.", "operationId": "Wallets_Get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the wallet to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Wallet was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WalletResponse" } ], "description": "Describes billing wallet data returned by Leadping." } } } }, "404": { "description": "The specified wallet 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." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } }, "/wallets/me": { "get": { "tags": [ "Wallets" ], "summary": "Get the current organization wallet balance", "description": "Returns the current organization wallet, including balance and funding status used for communication delivery and billing.", "operationId": "Wallets_GetForCurrentOrganization", "responses": { "200": { "description": "Wallet was successfully retrieved.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WalletResponse" } ], "description": "Describes billing wallet data returned by Leadping." } } } }, "404": { "description": "The current organization wallet 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." } } } }, "400": { "description": "The request was invalid or malformed.", "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.", "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." } } } }, "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": [ ] } ], "x-agentic-access": { "action-class": "connected", "consequences": [ "read" ], "subject": { "required": true }, "authorization": { "source": "OpenAPI security requirements", "audience": "https://api.leadping.ai" }, "audit": { "recommended": false } } } } }, "components": { "schemas": { "ActivationDomainOption": { "type": "object", "properties": { "domainName": { "type": "string", "description": "The domain name associated with this activation domain option." }, "whyItFits": { "type": "string", "description": "Why it fits for this activation domain option." }, "industryRelevance": { "type": "string", "description": "Industry relevance for this activation domain option." }, "trustConcerns": { "type": [ "null", "string" ], "description": "Trust concerns for this activation domain option." }, "estimatedAnnualCost": { "type": [ "null", "number" ], "description": "Estimated annual cost for this activation domain option.", "format": "double" }, "availabilityStatus": { "type": "string", "description": "The current availability status for this activation domain option." }, "recommended": { "type": "boolean", "description": "Whether this activation domain option is recommended." } }, "description": "Describes activation domain option data used in Leadping API requests and responses." }, "ActivationLaunchReviewStatus": { "enum": [ "NotReady", "Pending", "Approved", "NotRequired", "Blocked" ], "type": "string", "description": "Describes the administrative review decision that determines whether an organization can launch Leadping workflows." }, "ActivationOnboardingStatus": { "enum": [ "Draft", "Submitted", "Failed" ], "type": "string", "description": "Describes completion and blocking state for an organization's core Leadping onboarding requirements." }, "ActivationPaymentStatus": { "enum": [ "PaymentMethodPending", "PaymentMethodConfirmed", "Failed" ], "type": "string", "description": "Describes whether valid funding and payment prerequisites are satisfied during organization activation." }, "ActivationSubscriptionStatus": { "enum": [ "Pending", "Active", "Failed", "Canceled" ], "type": "string", "description": "Describes whether an organization's subscription is ready, blocked, or still incomplete during activation." }, "ActivationTelephonyStatus": { "enum": [ "NotStarted", "ProvisioningPending", "PartiallyProvisioned", "Ready", "Failed", "BlockedRequiresOperatorAction" ], "type": "string", "description": "Describes whether phone numbers, calling, messaging, and provider resources are ready for organization launch." }, "ActivationTimelineEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this activation timeline event." }, "type": { "type": "string", "description": "The type classification for this activation timeline event." }, "title": { "type": "string", "description": "Title for this activation timeline event." }, "details": { "type": [ "null", "string" ], "description": "Details for this activation timeline event." }, "status": { "type": "string", "description": "The current status for this activation timeline event." }, "actor": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related actor." }, "failureReason": { "type": [ "null", "string" ], "description": "The human-readable failure reason explaining this activation timeline event." }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this activation timeline event.", "format": "date-time" } }, "description": "Describes activation timeline event data used in Leadping API requests and responses." }, "AnalyticsBucketSize": { "enum": [ 3, 0, 1, 2 ], "type": "integer", "description": "Selects the time interval used to aggregate points in a Leadping analytics trend series.", "format": "int32" }, "AnalyticsComparison": { "type": "object", "properties": { "current": { "type": "number", "description": "Metric value for the current reporting period.", "format": "double" }, "previous": { "type": "number", "description": "Metric value for the preceding comparison period.", "format": "double" }, "changePercent": { "type": [ "null", "number" ], "description": "Percentage change between the current and previous reporting periods.", "format": "double" }, "direction": { "type": "string", "description": "Direction classification for this Leadping analytics comparison." } }, "description": "Compares a metric with the preceding period and reports its absolute and percentage change." }, "AnalyticsDateRange": { "type": "object", "properties": { "startAt": { "type": "string", "description": "Date and time when this Leadping analytics date range was start.", "format": "date-time" }, "endAt": { "type": "string", "description": "Date and time when this Leadping analytics date range was end.", "format": "date-time" }, "bucketSize": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsBucketSize" } ], "description": "Bucket size associated with this Leadping analytics date range." } }, "description": "Defines the inclusive reporting window and comparison window used to calculate Leadping analytics." }, "AnalyticsTrendPointOfdecimal": { "type": "object", "properties": { "startAt": { "type": "string", "description": "Date and time when this Leadping analytics trend point was start.", "format": "date-time" }, "endAt": { "type": "string", "description": "Date and time when this Leadping analytics trend point was end.", "format": "date-time" }, "label": { "type": "string", "description": "Human-readable label for this Leadping analytics trend point." }, "value": { "type": "number", "description": "Value associated with this Leadping analytics trend point.", "format": "double" } }, "description": "Associates a typed analytics value with one normalized time bucket in a trend series." }, "AnalyticsTrendPointOfint": { "type": "object", "properties": { "startAt": { "type": "string", "description": "Date and time when this Leadping analytics trend point was start.", "format": "date-time" }, "endAt": { "type": "string", "description": "Date and time when this Leadping analytics trend point was end.", "format": "date-time" }, "label": { "type": "string", "description": "Human-readable label for this Leadping analytics trend point." }, "value": { "type": "integer", "description": "Value associated with this Leadping analytics trend point.", "format": "int32" } }, "description": "Associates a typed analytics value with one normalized time bucket in a trend series." }, "AutomationAction": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this automation action." }, "type": { "type": "string", "description": "Type classification used to route and interpret this automation action in the Leadping API." }, "order": { "type": "integer", "description": "Sort order used to evaluate or display this automation action.", "format": "int32" }, "isEnabled": { "type": "boolean", "description": "Indicates whether this automation action is active and allowed to run." }, "settings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value settings that configure how this automation action behaves." } }, "description": "Public Leadping API schema for automation action data." }, "AutomationActionRunRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this automation action run record." }, "automationRunId": { "type": [ "null", "string" ], "description": "Automation run ID connected to this action or event record." }, "actionId": { "type": [ "null", "string" ], "description": "Automation action ID executed or evaluated by this automation action run record." }, "actionType": { "type": "string", "description": "Automation action type, such as send SMS or create task." }, "order": { "type": "integer", "description": "Sort order used to evaluate or display this automation action run record.", "format": "int32" }, "status": { "type": "string", "description": "Current lifecycle status for this automation action run record in the Leadping API." }, "selectedConnectionId": { "type": [ "null", "string" ], "description": "Connection selected by a control-flow action such as a weighted random split." }, "startedAt": { "type": "string", "description": "UTC timestamp when processing started for this automation action run record.", "format": "date-time" }, "scheduledAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this automation action run record was scheduled.", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when processing completed for this automation action run record.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when processing failed for this automation action run record.", "format": "date-time" }, "processingAttempts": { "type": "integer", "description": "Number of processing attempts made for this workflow or delivery request.", "format": "int32" }, "nextRetryAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping will retry this automation action run record.", "format": "date-time" }, "failureCode": { "type": [ "null", "string" ], "description": "Machine-readable failure code for troubleshooting this automation action run record." } }, "description": "History record schema for Leadping API automation action run record data exposed in automation and audit views." }, "AutomationCondition": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this automation condition." }, "type": { "type": "string", "description": "Type classification used to route and interpret this automation condition in the Leadping API." }, "operator": { "type": [ "null", "string" ], "description": "Automation comparison operator used by this condition." }, "isEnabled": { "type": "boolean", "description": "Indicates whether this automation condition is active and allowed to run." }, "settings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value settings that configure how this automation condition behaves." } }, "description": "Public Leadping API schema for automation condition data." }, "AutomationConditionGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this automation condition group." }, "mode": { "type": "string", "description": "Execution mode that controls how this automation condition group is evaluated." }, "conditions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationCondition" } ], "description": "Public Leadping API schema for automation condition data." }, "description": "Automation conditions evaluated before an action or workflow runs." } }, "description": "Public Leadping API schema for automation condition group data." }, "AutomationConnection": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this connection." }, "sourceNodeId": { "type": "string", "description": "Graph node identifier where the connection begins." }, "targetNodeId": { "type": "string", "description": "Graph node identifier where the connection ends." }, "weight": { "type": "integer", "description": "Percentage chance assigned to this connection when it leaves a weighted random split. Ignored for connections from other node types.", "format": "int32" } }, "description": "A directed connection between two nodes in an automation graph." }, "AutomationConsoleResponse": { "type": "object", "properties": { "automationId": { "type": "string", "description": "Unique identifier of the automation whose execution history is returned." }, "runs": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationWorkflowRunResponse" } ], "description": "User-safe automation workflow run status returned for a lead." }, "description": "Recent persisted workflow runs for the automation, ordered for console display." } }, "description": "Recent persisted execution runs for an automation console." }, "AutomationPreviewActionResult": { "type": "object", "properties": { "actionId": { "type": [ "null", "string" ], "description": "Automation action ID executed or evaluated by this automation preview action result." }, "summary": { "type": "string", "description": "Short human-readable summary of this automation preview action result for lists, timelines, and notifications." }, "renderedOutput": { "type": "string", "description": "Rendered preview output produced by this automation preview action result." }, "wouldHaveSideEffect": { "type": "boolean", "description": "Indicates whether the automation preview would perform an external action if executed live." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Warnings returned for this automation preview action result that do not necessarily block processing." } }, "description": "Result schema for the Leadping API automation preview action result returned by lookup and validation endpoints." }, "AutomationPreviewConditionResult": { "type": "object", "properties": { "conditionId": { "type": [ "null", "string" ], "description": "Automation condition ID evaluated by this preview result." }, "summary": { "type": "string", "description": "Short human-readable summary of this automation preview condition result for lists, timelines, and notifications." }, "passed": { "type": "boolean", "description": "Indicates whether this automation preview condition result passed the preview or validation check." } }, "description": "Result schema for the Leadping API automation preview condition result returned by lookup and validation endpoints." }, "AutomationPreviewRequest": { "required": [ "automation" ], "type": "object", "properties": { "automation": { "allOf": [ { "$ref": "#/components/schemas/AutomationRequestSnapshot" } ], "description": "Automation configuration to evaluate without executing live actions." }, "triggerType": { "type": [ "null", "string" ], "description": "Automation trigger type that starts the workflow." } }, "description": "Defines the fields clients can send when working with automation preview." }, "AutomationPreviewResponse": { "type": "object", "properties": { "triggerType": { "type": [ "null", "string" ], "description": "Automation trigger type that starts the workflow." }, "samplePayload": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Example payload clients can use to understand this automation preview response format." }, "validation": { "allOf": [ { "$ref": "#/components/schemas/AutomationValidationResult" } ], "description": "Validation result returned for the automation configuration." }, "conditionResults": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationPreviewConditionResult" } ], "description": "Result schema for the Leadping API automation preview condition result returned by lookup and validation endpoints." }, "description": "Condition evaluation results returned by the automation preview." }, "actionResults": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationPreviewActionResult" } ], "description": "Result schema for the Leadping API automation preview action result returned by lookup and validation endpoints." }, "description": "Action preview results showing what the automation would do." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Warnings returned for this automation preview response that do not necessarily block processing." } }, "description": "Describes automation preview data returned by Leadping." }, "AutomationRequest": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this automation configuration request to API users." }, "enabled": { "type": [ "null", "boolean" ], "description": "Indicates whether this automation configuration request is active and available in the Leadping API." }, "scope": { "type": [ "null", "string" ], "description": "Scope that limits where this automation configuration request applies in Leadping." }, "visibility": { "type": [ "null", "string" ], "description": "Visibility level that controls who can see this automation configuration request." }, "triggers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationTrigger" } ], "description": "Public Leadping API schema for automation trigger data." }, "description": "Automation triggers that can start this workflow." }, "conditionGroups": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationConditionGroup" } ], "description": "Public Leadping API schema for automation condition group data." }, "description": "Grouped automation conditions used to decide whether this workflow should run." }, "actions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationAction" } ], "description": "Public Leadping API schema for automation action data." }, "description": "Automation actions configured or returned for this workflow." }, "connections": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationConnection" } ], "description": "A directed connection between two nodes in an automation graph." }, "description": "Directed connections between nodes in this automation graph." }, "version": { "type": "integer", "description": "Version number for this automation configuration request schema or saved configuration.", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Human-readable display name for the resource, subject to the API's maximum name length." }, "id": { "type": [ "null", "string" ], "description": "Stable unique identifier of an existing resource to update; omit it when the API assigns an identifier during creation." } }, "description": "Defines the fields clients can send when working with automation configuration." }, "AutomationRequestSnapshot": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Unique Leadping identifier for this automation request snapshot." }, "name": { "type": [ "null", "string" ], "description": "Display name for this automation request snapshot in the Leadping API." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this automation request snapshot to API users." }, "enabled": { "type": [ "null", "boolean" ], "description": "Indicates whether this automation request snapshot is active and available in the Leadping API." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID captured when the automation request snapshot was created." }, "createdByUserId": { "type": [ "null", "string" ], "description": "User ID of the person who created this automation request snapshot." }, "scope": { "type": [ "null", "string" ], "description": "Scope that limits where this automation request snapshot applies in Leadping." }, "visibility": { "type": [ "null", "string" ], "description": "Visibility level that controls who can see this automation request snapshot." }, "managementLevel": { "type": [ "null", "string" ], "description": "Management level that controls whether Leadping or the organization owns this automation setting." }, "isSystemManaged": { "type": "boolean", "description": "Indicates whether Leadping manages this automation request snapshot automatically instead of a user." }, "triggers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationTrigger" } ], "description": "Public Leadping API schema for automation trigger data." }, "description": "Automation triggers that can start this workflow." }, "conditionGroups": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationConditionGroup" } ], "description": "Public Leadping API schema for automation condition group data." }, "description": "Grouped automation conditions used to decide whether this workflow should run." }, "actions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationAction" } ], "description": "Public Leadping API schema for automation action data." }, "description": "Automation actions configured or returned for this workflow." }, "connections": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationConnection" } ], "description": "A directed connection between two nodes in an automation graph." }, "description": "Directed connections between nodes in this automation graph." } }, "description": "Public Leadping API schema for automation request snapshot data." }, "AutomationResponse": { "type": "object", "properties": { "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this automation configuration response to API users." }, "enabled": { "type": [ "null", "boolean" ], "description": "Indicates whether this automation configuration response is active and available in the Leadping API." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID that owns this automation." }, "createdByUserId": { "type": [ "null", "string" ], "description": "User ID of the person who created this automation configuration response." }, "scope": { "type": [ "null", "string" ], "description": "Scope that limits where this automation configuration response applies in Leadping." }, "visibility": { "type": [ "null", "string" ], "description": "Visibility level that controls who can see this automation configuration response." }, "managementLevel": { "type": [ "null", "string" ], "description": "Management level that controls whether Leadping or the organization owns this automation setting." }, "isSystemManaged": { "type": "boolean", "description": "Indicates whether Leadping manages this automation configuration response automatically instead of a user." }, "triggers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationTrigger" } ], "description": "Public Leadping API schema for automation trigger data." }, "description": "Automation triggers that can start this workflow." }, "conditionGroups": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationConditionGroup" } ], "description": "Public Leadping API schema for automation condition group data." }, "description": "Grouped automation conditions used to decide whether this workflow should run." }, "actions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationAction" } ], "description": "Public Leadping API schema for automation action data." }, "description": "Automation actions configured or returned for this workflow." }, "connections": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationConnection" } ], "description": "A directed connection between two nodes in an automation graph." }, "description": "Directed connections between nodes in this automation graph." }, "lastRunAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this automation last ran.", "format": "date-time" }, "lastRunStatus": { "type": [ "null", "string" ], "description": "Status from the most recent automation run." }, "version": { "type": "integer", "description": "Version number for this automation configuration response schema or saved configuration.", "format": "int32" }, "user": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary connected to this automation configuration response." }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Organization summary connected to this automation configuration response." }, "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 automation configuration data returned by Leadping." }, "AutomationRunRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this automation run record." }, "automationId": { "type": [ "null", "string" ], "description": "Automation ID connected to this workflow, run, or event." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID that owns this automation run." }, "leadId": { "type": [ "null", "string" ], "description": "Lead ID that triggered this automation run, when the run is lead-based." }, "triggerType": { "type": [ "null", "string" ], "description": "Automation trigger type that starts the workflow." }, "status": { "type": "string", "description": "Current lifecycle status for this automation run record in the Leadping API." }, "executionMode": { "type": "string", "description": "Execution mode used for automation preview or live workflow processing." }, "startedAt": { "type": "string", "description": "UTC timestamp when processing started for this automation run record.", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when processing completed for this automation run record.", "format": "date-time" }, "processingAttempts": { "type": "integer", "description": "Number of processing attempts made for this workflow or delivery request.", "format": "int32" }, "lastAttemptAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping last attempted to process this automation run.", "format": "date-time" }, "failureCode": { "type": [ "null", "string" ], "description": "Machine-readable failure code for troubleshooting this automation run record." }, "skippedReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining why Leadping skipped this automation run." }, "actions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationActionRunRecord" } ], "description": "History record schema for Leadping API automation action run record data exposed in automation and audit views." }, "description": "Automation actions configured or returned for this workflow." } }, "description": "History record schema for Leadping API automation run record data exposed in automation and audit views." }, "AutomationTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this automation table row." }, "name": { "type": "string", "description": "Display name for this automation table row in the Leadping API." }, "description": { "type": "string", "description": "Human-readable description that explains this automation table row to API users." }, "enabled": { "type": "boolean", "description": "Indicates whether this automation table row is active and available in the Leadping API." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID that owns this automation." }, "createdByUserId": { "type": [ "null", "string" ], "description": "User ID of the person who created this automation table row." }, "scope": { "type": [ "null", "string" ], "description": "Scope that limits where this automation table row applies in Leadping." }, "visibility": { "type": [ "null", "string" ], "description": "Visibility level that controls who can see this automation table row." }, "managementLevel": { "type": [ "null", "string" ], "description": "Management level that controls whether Leadping or the organization owns this automation setting." }, "isSystemManaged": { "type": "boolean", "description": "Indicates whether Leadping manages this automation table row automatically instead of a user." }, "triggerType": { "type": "string", "description": "Automation trigger type that starts the workflow." }, "triggerSummary": { "type": "string", "description": "Human-readable summary of the automation trigger that started the workflow." }, "conditionSummary": { "type": "string", "description": "Human-readable summary of the automation condition evaluation." }, "actionSummary": { "type": "string", "description": "Human-readable summary of the automation action outcome." }, "ruleSentence": { "type": "string", "description": "Human-readable explanation of the automation rule being evaluated." }, "lastRunStatus": { "type": [ "null", "string" ], "description": "Status from the most recent automation run." }, "lastRunAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this automation last ran.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "UTC timestamp when this automation table row was last modified.", "format": "date-time" }, "healthSummary": { "type": "string", "description": "Human-readable health summary for this automation table row." }, "user": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary connected to this automation table row." }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Organization summary connected to this automation table row." } }, "description": "Summarizes automation data in paginated and searchable results." }, "AutomationTrigger": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this automation trigger." }, "type": { "type": "string", "description": "Type classification used to route and interpret this automation trigger in the Leadping API." }, "displayName": { "type": [ "null", "string" ], "description": "Human-readable display name shown for this automation trigger." }, "isEnabled": { "type": "boolean", "description": "Indicates whether this automation trigger is active and allowed to run." }, "settings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value settings that configure how this automation trigger behaves." } }, "description": "Public Leadping API schema for automation trigger data." }, "AutomationValidationResult": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "description": "Validation or processing errors returned for this automation validation result." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Warnings returned for this automation validation result that do not necessarily block processing." } }, "description": "Result schema for the Leadping API automation validation result returned by lookup and validation endpoints." }, "AutomationWorkflowActionResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for the automation workflow action." }, "stepId": { "type": [ "null", "string" ], "description": "Unique identifier of the step associated with this Leadping automation workflow action." }, "stepOrder": { "type": "integer", "description": "Step order associated with this Leadping automation workflow action.", "format": "int32" }, "stepDisplayName": { "type": "string", "description": "Human-readable step display name associated with this Leadping automation workflow action." }, "actionType": { "type": "string", "description": "Action type classification for this Leadping automation workflow action." }, "actionTypeDisplay": { "type": "string", "description": "Human-readable action type display for this Leadping automation workflow action." }, "status": { "type": "string", "description": "Current status for this Leadping automation workflow action." }, "statusDisplay": { "type": "string", "description": "Human-readable status display for this Leadping automation workflow action." }, "scheduledAt": { "type": [ "null", "string" ], "description": "Date and time when the automation workflow action was scheduled.", "format": "date-time" }, "startedAt": { "type": [ "null", "string" ], "description": "Date and time when the automation workflow action started.", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "description": "Date and time when the automation workflow action completed.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "Date and time when the automation workflow action failed.", "format": "date-time" }, "skippedAt": { "type": [ "null", "string" ], "description": "Date and time when the workflow action was skipped.", "format": "date-time" }, "retryCount": { "type": "integer", "description": "Total number of retry records represented by this Leadping automation workflow action.", "format": "int32" }, "nextRetryAt": { "type": [ "null", "string" ], "description": "Date and time when the next retry is scheduled.", "format": "date-time" }, "userSummary": { "type": [ "null", "string" ], "description": "Human-readable user summary for this Leadping automation workflow action." }, "safeReason": { "type": [ "null", "string" ], "description": "Safe reason associated with this Leadping automation workflow action." }, "failureCode": { "type": [ "null", "string" ], "description": "Reason or diagnostic code that explains the current outcome for this Leadping automation workflow action." } }, "description": "User-safe action status returned for lead automation workflow visibility." }, "AutomationWorkflowEventResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for the automation workflow event." }, "stepId": { "type": [ "null", "string" ], "description": "Unique identifier of the step associated with this Leadping automation workflow event." }, "actionId": { "type": [ "null", "string" ], "description": "Unique identifier of the action associated with this Leadping automation workflow event." }, "eventType": { "type": "string", "description": "Event type classification for this Leadping automation workflow event." }, "status": { "type": "string", "description": "Current status for this Leadping automation workflow event." }, "statusDisplay": { "type": "string", "description": "Human-readable status display for this Leadping automation workflow event." }, "summary": { "type": "string", "description": "Human-readable summary for this Leadping automation workflow event." }, "reasonCode": { "type": [ "null", "string" ], "description": "Reason or diagnostic code that explains the current outcome for this Leadping automation workflow event." }, "occurredAt": { "type": "string", "description": "Date and time when the automation workflow event event occurred.", "format": "date-time" } }, "description": "User-safe workflow history event returned for lead automation status." }, "AutomationWorkflowRunResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for the automation workflow run." }, "organizationId": { "type": [ "null", "string" ], "description": "Unique identifier of the organization associated with this Leadping automation workflow run." }, "leadId": { "type": [ "null", "string" ], "description": "Unique identifier of the lead associated with this Leadping automation workflow run." }, "automation": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related automation." }, "triggerType": { "type": [ "null", "string" ], "description": "Trigger type classification for this Leadping automation workflow run." }, "triggerDisplay": { "type": [ "null", "string" ], "description": "Human-readable trigger display for this Leadping automation workflow run." }, "status": { "type": "string", "description": "Current status for this Leadping automation workflow run." }, "statusDisplay": { "type": "string", "description": "Human-readable status display for this Leadping automation workflow run." }, "currentStep": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the workflow step currently awaiting or performing work." }, "currentStepOrder": { "type": [ "null", "integer" ], "description": "Current step order associated with this Leadping automation workflow run.", "format": "int32" }, "nextExecutionAt": { "type": [ "null", "string" ], "description": "Date and time when the next execution is scheduled.", "format": "date-time" }, "lastExecutionAt": { "type": [ "null", "string" ], "description": "Date and time of the most recent execution for this Leadping automation workflow run.", "format": "date-time" }, "startedAt": { "type": "string", "description": "Date and time when the automation workflow run started.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "Date and time when the automation workflow run was last updated.", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "description": "Date and time when the automation workflow run completed.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "Date and time when the automation workflow run failed.", "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "description": "Date and time when the automation workflow run was cancelled.", "format": "date-time" }, "retryCount": { "type": "integer", "description": "Total number of retry records represented by this Leadping automation workflow run.", "format": "int32" }, "maxRetryCount": { "type": "integer", "description": "Total number of max retry records represented by this Leadping automation workflow run.", "format": "int32" }, "nextRetryAt": { "type": [ "null", "string" ], "description": "Date and time when the next retry is scheduled.", "format": "date-time" }, "lastErrorCode": { "type": [ "null", "string" ], "description": "Machine-readable code for the most recent workflow execution error." }, "lastErrorMessage": { "type": [ "null", "string" ], "description": "Human-readable last error message for this Leadping automation workflow run." }, "skipReasonCode": { "type": [ "null", "string" ], "description": "Machine-readable code explaining why the workflow run or action was skipped." }, "skipReasonDisplay": { "type": [ "null", "string" ], "description": "Human-readable skip reason display for this Leadping automation workflow run." }, "lastActionSummary": { "type": [ "null", "string" ], "description": "Human-readable last action summary for this Leadping automation workflow run." }, "actions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationWorkflowActionResponse" } ], "description": "User-safe action status returned for lead automation workflow visibility." }, "description": "Collection of actions included with this Leadping automation workflow run." }, "events": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationWorkflowEventResponse" } ], "description": "User-safe workflow history event returned for lead automation status." }, "description": "Collection of events included with this Leadping automation workflow run." } }, "description": "User-safe automation workflow run status returned for a lead." }, "AutomationWorkflowStatusResponse": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Unique identifier of the lead associated with this Leadping automation workflow status." }, "runs": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationWorkflowRunResponse" } ], "description": "User-safe automation workflow run status returned for a lead." }, "description": "Collection of runs included with this Leadping automation workflow status." } }, "description": "Automation workflow status collection for a lead." }, "BillableUnit": { "enum": [ "lead_received", "phone_identity_lookup", "sms_segment", "mms_message", "email_message", "voice_minute", "phone_number_month", "warmup_sms_segment", "warmup_voice_minute", "website_setup", "openai_operation", "domain_registration", "10dlc_application", "10dlc_campaign_month", "payment_processing_fee", "connection_action", "automation_run" ], "type": "string", "description": "Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number." }, "BillingPlan": { "enum": [ "Annual", "Monthly" ], "type": "string", "description": "Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior." }, "BlogArticleResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Gets or sets the ID." }, "title": { "type": "string", "description": "Gets or sets the title." }, "slug": { "type": "string", "description": "Gets or sets the slug." }, "excerpt": { "type": "string", "description": "Gets or sets the excerpt." }, "content": { "type": "string", "description": "Gets or sets the content." }, "category": { "type": [ "null", "string" ], "description": "Gets or sets the category." }, "authorName": { "type": [ "null", "string" ], "description": "Gets or sets the author name." }, "coverImageUrl": { "type": [ "null", "string" ], "description": "Gets or sets the cover image URL.", "format": "uri" }, "publishedAt": { "type": [ "null", "string" ], "description": "Gets or sets the published at.", "format": "date-time" }, "isPublished": { "type": "boolean", "description": "Gets or sets the is published." }, "isFeatured": { "type": "boolean", "description": "Gets or sets the is featured." }, "createdAt": { "type": "string", "description": "Gets or sets the created at.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Gets or sets the modified at.", "format": "date-time" } }, "description": "Represents a blog article response." }, "CallEventTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this call event table row." }, "leadId": { "type": [ "null", "string" ], "description": "Lead ID associated with this call event." }, "leadName": { "type": [ "null", "string" ], "description": "Display name for the lead associated with this call event." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID associated with this call event." }, "userId": { "type": [ "null", "string" ], "description": "User ID associated with the person or agent who initiated this call event." }, "userName": { "type": [ "null", "string" ], "description": "Display name for the person or agent who initiated this call event." }, "userEmail": { "type": [ "null", "string" ], "description": "Email address for the person or agent who initiated this call event.", "format": "email" }, "conversationId": { "type": [ "null", "string" ], "description": "Conversation ID that links this call event table row to the Leadping inbox thread." }, "fromPhoneNumberId": { "type": [ "null", "string" ], "description": "Sender phone number ID used for this outbound SMS or call." }, "fromPhoneNumber": { "type": "string", "description": "Sender phone number used for this communication." }, "toPhoneNumber": { "type": "string", "description": "Recipient phone number used for this communication." }, "callerId": { "type": [ "null", "string" ], "description": "Caller ID phone number presented during the outbound call." }, "status": { "enum": [ "scheduled", "queued", "initiated", "ringing", "in_progress", "active", "completed", "ended", "busy", "no_answer", "failed", "canceled", "missed", "transferred", "voicemail", "blocked_billing", "blocked_phone_number_status", "blocked_configuration", "blocked_permission", "configuration_required" ], "type": [ "null", "string" ], "description": "Describes the durable business outcome of a Leadping phone call after provider status normalization." }, "statusReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining the current status of this call event table row." }, "direction": { "type": "string", "description": "Communication direction for this call event table row, such as inbound or outbound." }, "createdAt": { "type": "string", "description": "UTC timestamp when this call event table row was created.", "format": "date-time" }, "answeredAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the call was answered.", "format": "date-time" }, "endedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the call ended.", "format": "date-time" }, "duration": { "type": [ "null", "integer" ], "description": "Call duration or processing duration represented by this call event table row.", "format": "int32" }, "billableSeconds": { "type": [ "null", "integer" ], "description": "Billable call duration in seconds.", "format": "int32" }, "billableAmount": { "type": [ "null", "number" ], "description": "Monetary amount billed for this Leadping communication or transaction.", "format": "double" }, "billingStatus": { "type": [ "null", "string" ], "description": "Billing state for this communication, charge, or transaction." }, "recordingUrl": { "type": [ "null", "string" ], "description": "URL for the call recording, when the provider makes one available.", "format": "uri" }, "consoleEntries": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CommunicationConsoleEntry" } ], "description": "Describes one durable diagnostic entry from the processing of a communication." }, "description": "Ordered diagnostic entries recorded while Leadping processed this call." }, "user": { "type": "string", "description": "User summary connected to this call event table row." }, "organization": { "type": "string", "description": "Organization summary connected to this call event table row." }, "organizationName": { "type": [ "null", "string" ], "description": "Display name for the organization associated with this call event." } }, "description": "Summarizes call event data in paginated and searchable results." }, "ChangeBillingPlanRequest": { "required": [ "billingPlan" ], "type": "object", "properties": { "billingPlan": { "allOf": [ { "$ref": "#/components/schemas/BillingPlan" } ], "description": "Billing plan for this billing plan." } }, "description": "Defines the input used for change billing plan." }, "CommunicationConsoleEntry": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of this diagnostic console entry." }, "stage": { "type": "string", "description": "Communication-processing stage that produced the entry, such as validation, routing, or provider delivery." }, "status": { "type": "string", "description": "Outcome or state recorded for this processing stage." }, "message": { "type": "string", "description": "User-safe diagnostic message describing what occurred at this stage." }, "occurredAt": { "type": "string", "description": "UTC timestamp when this communication-processing event occurred.", "format": "date-time" } }, "description": "Describes one durable diagnostic entry from the processing of a communication." }, "ComplianceUpdateRequest": { "type": "object", "properties": { "compliance": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/UserCompliance" } ], "description": "Compliance for this compliance update." }, "source": { "type": [ "null", "string" ], "description": "Source for this compliance update." } }, "description": "Defines the input used for compliance update." }, "ConversationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this conversation response." }, "leadId": { "type": "string", "description": "Lead ID associated with this inbox conversation." }, "firstName": { "type": [ "null", "string" ], "description": "First name of the lead, user, or contact represented by this conversation response." }, "lastName": { "type": [ "null", "string" ], "description": "Last name of the lead, user, or contact represented by this conversation response." }, "email": { "type": [ "null", "string" ], "description": "Email address used to resolve the lead's avatar when available.", "format": "email" }, "avatarUrl": { "type": [ "null", "string" ], "description": "Optional profile image URL explicitly associated with the lead.", "format": "uri" }, "lastSnippet": { "type": [ "null", "string" ], "description": "Most recent message preview shown for the conversation." }, "lastEventAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the most recent conversation event occurred.", "format": "date-time" }, "lastEventIsInternalNote": { "type": "boolean", "description": "Indicates that the most recent conversation activity is an internal note." }, "status": { "enum": [ "needs_reply", "waiting", "failed", "open" ], "type": [ "null", "string" ], "description": "Defines the customer-facing operational status for an inbox conversation." }, "statusReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining the current status of this conversation response." }, "archivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this record was archived.", "format": "date-time" }, "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" }, "isArchived": { "type": "boolean", "description": "Indicates whether the Leadping conversation has been archived." }, "currentLeadStatus": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/CurrentLeadStatusSummary" } ], "description": "Current lead status change summary that describes the lead outcome." }, "nextStep": { "type": [ "null", "string" ], "description": "Recommended next step to move this conversation response forward." }, "isUnread": { "type": "boolean", "description": "Indicates whether the current user has unread activity in the conversation." }, "phoneNumber": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNameValue" } ], "description": "Phone number used by this conversation response for calls, SMS, lookup, or routing." }, "leadPhoneNumber": { "type": [ "null", "string" ], "description": "Lead's phone number used for conversation matching and outreach." }, "outboundPhoneNumberOverrideId": { "type": [ "null", "string" ], "description": "Phone number ID manually chosen to override automatic outbound selection." }, "activeOutboundPhoneNumberId": { "type": [ "null", "string" ], "description": "Phone number ID currently active for outbound delivery." } }, "description": "Describes conversation data returned by Leadping." }, "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." }, "CreateNoteRequest": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "Plain-text note content to add to the conversation timeline." } }, "description": "Defines the input used for create note." }, "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." }, "CustomerActivationHealth": { "type": "object", "properties": { "overallStatus": { "type": "string", "description": "Current overall status for this Leadping customer activation health." }, "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomerActivationHealthItem" } ], "description": "Describes the state, severity, and recommended next action for one organization activation requirement." }, "description": "Collection of items included with this Leadping customer activation health." } }, "description": "Summarizes an organization's progress and blockers across onboarding, billing, telephony, compliance, and launch readiness." }, "CustomerActivationHealthItem": { "type": "object", "properties": { "key": { "type": "string", "description": "Key associated with this Leadping customer activation health item." }, "label": { "type": "string", "description": "Human-readable label for this Leadping customer activation health item." }, "status": { "type": "string", "description": "Current status for this Leadping customer activation health item." }, "detail": { "type": "string", "description": "Human-readable detail for this Leadping customer activation health item." }, "actionHref": { "type": [ "null", "string" ], "description": "Relative URL for the recommended follow-up action." } }, "description": "Describes the state, severity, and recommended next action for one organization activation requirement." }, "CustomerActivationStatus": { "enum": [ "DraftOnboarding", "PaymentMethodPending", "PaymentMethodConfirmed", "SubscriptionPending", "SubscriptionReceived", "SubscriptionActive", "LaunchReviewPending", "TelephonyProvisioningPending", "TelephonyPartiallyProvisioned", "TelephonyReady", "AwaitingReview", "DomainSelection", "WebsiteSetup", "ComplianceRegistration", "ReadyForApproval", "Active", "Failed", "Blocked", "BlockedRequiresOperatorAction", "ManuallyBypassed" ], "type": "string", "description": "Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness." }, "CustomerAnalyticsResponse": { "type": "object", "properties": { "range": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsDateRange" } ], "description": "Range associated with this Leadping customer analytics." }, "summary": { "allOf": [ { "$ref": "#/components/schemas/CustomerAnalyticsSummary" } ], "description": "Human-readable summary for this Leadping customer analytics." }, "leadTrend": { "allOf": [ { "$ref": "#/components/schemas/CustomerLeadTrend" } ], "description": "Lead trend associated with this Leadping customer analytics." }, "responseMetrics": { "allOf": [ { "$ref": "#/components/schemas/CustomerResponseMetrics" } ], "description": "Response metrics associated with this Leadping customer analytics." }, "communicationUsage": { "allOf": [ { "$ref": "#/components/schemas/CustomerCommunicationUsage" } ], "description": "Communication usage associated with this Leadping customer analytics." }, "leadSources": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomerLeadSourceBreakdown" } ], "description": "Attributes an organization's lead volume, qualification, and conversion outcomes to a specific acquisition source." }, "description": "Collection of lead sources included with this Leadping customer analytics." }, "automationHealth": { "allOf": [ { "$ref": "#/components/schemas/CustomerAutomationHealth" } ], "description": "Automation health associated with this Leadping customer analytics." }, "activationHealth": { "allOf": [ { "$ref": "#/components/schemas/CustomerActivationHealth" } ], "description": "Activation health associated with this Leadping customer analytics." }, "needsAttention": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomerNeedsAttentionItem" } ], "description": "Identifies an organization-level issue or opportunity and provides severity, supporting context, and a recommended action." }, "description": "Date and time when this Leadping customer analytics was needs attention." }, "generatedAt": { "type": "string", "description": "Date and time when this Leadping customer analytics was generated.", "format": "date-time" } }, "description": "Aggregates an organization's lead performance, response speed, communication usage, automation health, and activation insights." }, "CustomerAnalyticsSummary": { "type": "object", "properties": { "leads": { "type": "integer", "description": "Number of leads represented by this Leadping customer analytics summary.", "format": "int32" }, "leadsComparison": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsComparison" } ], "description": "Date and time when this Leadping customer analytics summary was leads comparison." }, "averageResponseMinutes": { "type": [ "null", "number" ], "description": "Average time, in minutes, before a lead receives a response.", "format": "double" }, "medianResponseMinutes": { "type": [ "null", "number" ], "description": "Median response minutes measured in minutes.", "format": "double" }, "respondedWithinFiveMinutesPercent": { "type": "number", "description": "Responded within five minutes percent expressed as a percentage.", "format": "double" }, "missedLeads": { "type": "integer", "description": "Number of missed leads represented by this Leadping customer analytics summary.", "format": "int32" }, "unreadMessages": { "type": "integer", "description": "Number of unread messages represented by this Leadping customer analytics summary.", "format": "int32" }, "missedCalls": { "type": "integer", "description": "Number of calls missed during the reporting period.", "format": "int32" }, "smsSent": { "type": "integer", "description": "Number of SMS messages sent during the reporting period.", "format": "int32" }, "smsReceived": { "type": "integer", "description": "Number of SMS messages received during the reporting period.", "format": "int32" }, "callsPlaced": { "type": "integer", "description": "Number of outbound calls placed during the reporting period.", "format": "int32" }, "callsReceived": { "type": "integer", "description": "Number of inbound calls received during the reporting period.", "format": "int32" }, "callMinutes": { "type": "number", "description": "Total connected call duration, in minutes, during the reporting period.", "format": "double" }, "usageSpend": { "type": "number", "description": "Usage spend represented by this Leadping customer analytics summary.", "format": "double" }, "walletBalance": { "type": "number", "description": "Wallet balance represented by this Leadping customer analytics summary.", "format": "double" }, "billingStatus": { "type": "string", "description": "Current billing status for this Leadping customer analytics summary." }, "walletStatus": { "type": "string", "description": "Current wallet status for this Leadping customer analytics summary." } }, "description": "Summarizes an organization's primary lead, response, communication, and conversion KPIs for the selected period." }, "CustomerAutomationHealth": { "type": "object", "properties": { "automationCount": { "type": "integer", "description": "Total number of automation records represented by this Leadping customer automation health.", "format": "int32" }, "enabledCount": { "type": "integer", "description": "Total number of enabled records represented by this Leadping customer automation health.", "format": "int32" }, "executions": { "type": "integer", "description": "Number of executions represented by this Leadping customer automation health.", "format": "int32" }, "successCount": { "type": "integer", "description": "Total number of success records represented by this Leadping customer automation health.", "format": "int32" }, "failureCount": { "type": "integer", "description": "Total number of failure records represented by this Leadping customer automation health.", "format": "int32" }, "trend": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomerAutomationHealthPoint" } ], "description": "Measures automation execution activity within one analytics time bucket." }, "description": "Automation execution activity over the reporting period." }, "lastFailure": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/CustomerFailingAutomation" } ], "description": "Last failure associated with this Leadping customer automation health." }, "failingAutomations": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomerFailingAutomation" } ], "description": "Identifies an automation with recent execution failures and summarizes its affected leads and failure context." }, "description": "Collection of failing automations included with this Leadping customer automation health." } }, "description": "Summarizes automation coverage, execution success, failures, and workflows requiring organization attention." }, "CustomerAutomationHealthPoint": { "type": "object", "properties": { "startAt": { "type": "string", "description": "Gets or sets the start at.", "format": "date-time" }, "endAt": { "type": "string", "description": "Gets or sets the end at.", "format": "date-time" }, "label": { "type": "string", "description": "Gets or sets the label." }, "executions": { "type": "integer", "description": "Gets or sets the executions.", "format": "int32" }, "successCount": { "type": "integer", "description": "Gets or sets the success count.", "format": "int32" }, "failureCount": { "type": "integer", "description": "Gets or sets the failure count.", "format": "int32" } }, "description": "Measures automation execution activity within one analytics time bucket." }, "CustomerCommunicationUsage": { "type": "object", "properties": { "smsSent": { "type": "integer", "description": "Number of SMS messages sent during the reporting period.", "format": "int32" }, "smsReceived": { "type": "integer", "description": "Number of SMS messages received during the reporting period.", "format": "int32" }, "failedOrBlockedSms": { "type": "integer", "description": "Number of SMS messages that failed or were blocked during the reporting period.", "format": "int32" }, "callsPlaced": { "type": "integer", "description": "Number of outbound calls placed during the reporting period.", "format": "int32" }, "callsReceived": { "type": "integer", "description": "Number of inbound calls received during the reporting period.", "format": "int32" }, "callErrors": { "type": "integer", "description": "Number of calls that failed or were blocked during the reporting period.", "format": "int32" }, "answeredCalls": { "type": "integer", "description": "Number of calls answered during the reporting period.", "format": "int32" }, "missedCalls": { "type": "integer", "description": "Number of calls missed during the reporting period.", "format": "int32" }, "callMinutes": { "type": "number", "description": "Total connected call duration, in minutes, during the reporting period.", "format": "double" }, "usageSpend": { "type": "number", "description": "Usage spend represented by this Leadping customer communication usage.", "format": "double" }, "trend": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomerCommunicationUsagePoint" } ], "description": "Measures organization messaging and calling activity within one analytics time bucket." }, "description": "Collection of trend included with this Leadping customer communication usage." } }, "description": "Aggregates an organization's SMS, MMS, and calling activity, delivery outcomes, and billable usage over time." }, "CustomerCommunicationUsagePoint": { "type": "object", "properties": { "startAt": { "type": "string", "description": "Date and time when this Leadping customer communication usage point was start.", "format": "date-time" }, "endAt": { "type": "string", "description": "Date and time when this Leadping customer communication usage point was end.", "format": "date-time" }, "label": { "type": "string", "description": "Human-readable label for this Leadping customer communication usage point." }, "smsSent": { "type": "integer", "description": "Number of SMS messages sent during the reporting period.", "format": "int32" }, "smsReceived": { "type": "integer", "description": "Number of SMS messages received during the reporting period.", "format": "int32" }, "smsErrors": { "type": "integer", "description": "Number of SMS messages that failed or were blocked in this time bucket.", "format": "int32" }, "calls": { "type": "integer", "description": "Number of calls represented by this Leadping customer communication usage point.", "format": "int32" }, "callsPlaced": { "type": "integer", "description": "Number of outbound calls placed in this time bucket.", "format": "int32" }, "callsReceived": { "type": "integer", "description": "Number of inbound calls received in this time bucket.", "format": "int32" }, "callErrors": { "type": "integer", "description": "Number of calls that failed or were blocked in this time bucket.", "format": "int32" }, "callMinutes": { "type": "number", "description": "Total connected call duration, in minutes, during the reporting period.", "format": "double" }, "spend": { "type": "number", "description": "Spend represented by this Leadping customer communication usage point.", "format": "double" } }, "description": "Measures organization messaging and calling activity within one analytics time bucket." }, "CustomerFailingAutomation": { "type": "object", "properties": { "automationId": { "type": [ "null", "string" ], "description": "Unique identifier of the automation associated with this Leadping customer failing automation." }, "name": { "type": "string", "description": "Human-readable name of the customer failing automation." }, "failedAt": { "type": [ "null", "string" ], "description": "Date and time when the customer failing automation failed.", "format": "date-time" }, "error": { "type": [ "null", "string" ], "description": "Error associated with this Leadping customer failing automation." } }, "description": "Identifies an automation with recent execution failures and summarizes its affected leads and failure context." }, "CustomerLeadSourceBreakdown": { "type": "object", "properties": { "source": { "type": "string", "description": "Source classification for this Leadping customer lead source breakdown." }, "leads": { "type": "integer", "description": "Number of leads represented by this Leadping customer lead source breakdown.", "format": "int32" }, "percent": { "type": "number", "description": "Percent expressed as a percentage.", "format": "double" } }, "description": "Attributes an organization's lead volume, qualification, and conversion outcomes to a specific acquisition source." }, "CustomerLeadTrend": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of total records represented by this Leadping customer lead trend.", "format": "int32" }, "totalErrors": { "type": "integer", "description": "Total number of lead submissions rejected during intake.", "format": "int32" }, "comparison": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsComparison" } ], "description": "Date and time when this Leadping customer lead trend was comparison." }, "points": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsTrendPointOfint" } ], "description": "Associates a typed analytics value with one normalized time bucket in a trend series." }, "description": "Collection of points included with this Leadping customer lead trend." }, "errorPoints": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsTrendPointOfint" } ], "description": "Associates a typed analytics value with one normalized time bucket in a trend series." }, "description": "Lead intake errors grouped into the same reporting buckets as Points." } }, "description": "Measures lead creation, qualification, and conversion activity within one reporting time bucket." }, "CustomerNeedsAttentionItem": { "type": "object", "properties": { "severity": { "type": "string", "description": "Severity associated with this Leadping customer needs attention item." }, "title": { "type": "string", "description": "Human-readable title for this Leadping customer needs attention item." }, "detail": { "type": "string", "description": "Human-readable detail for this Leadping customer needs attention item." }, "actionHref": { "type": [ "null", "string" ], "description": "Relative URL for the recommended follow-up action." }, "actionText": { "type": [ "null", "string" ], "description": "Action text associated with this Leadping customer needs attention item." } }, "description": "Identifies an organization-level issue or opportunity and provides severity, supporting context, and a recommended action." }, "CustomerResponseMetrics": { "type": "object", "properties": { "averageMinutes": { "type": [ "null", "number" ], "description": "Average minutes measured in minutes.", "format": "double" }, "medianMinutes": { "type": [ "null", "number" ], "description": "Median minutes measured in minutes.", "format": "double" }, "respondedWithinFiveMinutesPercent": { "type": "number", "description": "Responded within five minutes percent expressed as a percentage.", "format": "double" }, "respondedLeads": { "type": "integer", "description": "Number of responded leads represented by this Leadping customer response metrics.", "format": "int32" }, "unrespondedLeads": { "type": "integer", "description": "Number of unresponded leads represented by this Leadping customer response metrics.", "format": "int32" }, "unreadMessages": { "type": "integer", "description": "Number of unread messages represented by this Leadping customer response metrics.", "format": "int32" }, "missedCalls": { "type": "integer", "description": "Number of calls missed during the reporting period.", "format": "int32" }, "averageMinutesTrend": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsTrendPointOfdecimal" } ], "description": "Associates a typed analytics value with one normalized time bucket in a trend series." }, "description": "Collection of average minutes trend included with this Leadping customer response metrics." } }, "description": "Measures how quickly and consistently an organization responds to leads across supported communication channels." }, "EligibleOutgoingNumberResponse": { "type": "object", "properties": { "phoneNumberId": { "type": "string", "description": "Leadping phone number ID connected to this eligible outgoing phone number." }, "number": { "type": "string", "description": "E.164 phone number exposed by this eligible outgoing phone number." }, "displayNumber": { "type": "string", "description": "Human-readable phone number shown in Leadping UI and API responses." }, "healthStatus": { "enum": [ "Not Evaluated", "Evaluating", "Healthy", "Needs Attention", "Blocked" ], "type": [ "null", "string" ], "description": "Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic." }, "healthLabel": { "type": [ "null", "string" ], "description": "Short label describing the health state for display in dashboards." }, "healthWarning": { "type": [ "null", "string" ], "description": "Warning text that explains a potential health or readiness issue." }, "canSend": { "type": "boolean", "description": "Indicates whether Leadping can send outbound messages using this eligible outgoing phone number." }, "selectionReason": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionReason" } ], "description": "Reason Leadping selected this outbound sender number." }, "reasonLabel": { "type": "string", "description": "Human-readable label for the reason code on this eligible outgoing phone number." }, "label": { "type": [ "null", "string" ], "description": "Short display label for this eligible outgoing phone number, formatted for charts, filters, or list views." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this eligible outgoing phone number." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID used to determine this phone number's outbound eligibility." }, "teamId": { "type": [ "null", "string" ], "description": "Organization ID used to determine this phone number's outbound eligibility." }, "isSelected": { "type": "boolean", "description": "Indicates whether this eligible outgoing phone number was selected for the requested operation." } }, "description": "Describes a Leadping phone number that is eligible to send an outbound message or place a call." }, "EventDetailResponse": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Event type used to classify this timeline, SMS, call, or automation event." }, "secondaryEventType": { "type": [ "null", "string" ], "description": "Secondary event type used for additional event classification." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this event detail response to API users." }, "eventCategory": { "type": [ "null", "string" ], "description": "High-level category used to group this Leadping event." }, "timelineType": { "enum": [ "Message", "Sms", "Mms", "Call", "Voicemail", "Note", "LeadStatusChange", "LeadCreated", "LeadUpdated", "Notification", "Payment", "Warmup" ], "type": [ "null", "string" ], "description": "Classifies the kind of activity displayed in a lead or conversation event timeline." }, "timelineCategory": { "type": [ "null", "string" ], "description": "Timeline category used to group events for display and filtering." }, "conversationId": { "type": [ "null", "string" ], "description": "Conversation ID that links this event detail response to the Leadping inbox thread." }, "summary": { "type": [ "null", "string" ], "description": "Short human-readable summary of this event detail response for lists, timelines, and notifications." }, "direction": { "type": [ "null", "string" ], "description": "Communication direction for this event detail response, such as inbound or outbound." }, "status": { "enum": [ "Pending", "InProgress", "Completed", "Failed", "Cancelled" ], "type": [ "null", "string" ], "description": "Describes whether a Leadping event is pending, processing, completed, failed, or otherwise resolved." }, "statusReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining the current status of this event detail response." }, "fromPhoneNumberId": { "type": [ "null", "string" ], "description": "Sender phone number ID used for this outbound SMS or call." }, "outboundPhoneNumberId": { "type": [ "null", "string" ], "description": "Phone number ID selected for outbound delivery." }, "fromPhoneNumber": { "type": [ "null", "string" ], "description": "Sender phone number used for this communication." }, "toPhoneNumber": { "type": [ "null", "string" ], "description": "Recipient phone number used for this communication." }, "queuedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping queued this event detail response for processing.", "format": "date-time" }, "scheduledFor": { "type": [ "null", "string" ], "description": "UTC timestamp when the related delivery or workflow action is scheduled to run.", "format": "date-time" }, "sendingStartedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping began sending this message.", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping sent this message to the provider.", "format": "date-time" }, "deliveredAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider confirmed delivery.", "format": "date-time" }, "receivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping received this inbound event or message.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when processing failed for this event detail response.", "format": "date-time" }, "undeliverableAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider marked the message undeliverable.", "format": "date-time" }, "blockedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping blocked this communication.", "format": "date-time" }, "canceledAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this delivery or workflow was canceled.", "format": "date-time" }, "user": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary connected to this event detail response." }, "userEmail": { "type": [ "null", "string" ], "description": "Email address for the user connected to this event detail response.", "format": "email" }, "userId": { "type": "string", "description": "User ID associated with the activity that created this event." }, "leadId": { "type": [ "null", "string" ], "description": "Lead ID associated with this event detail 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 event detail data returned by Leadping." }, "EventTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this event timeline table row." }, "eventType": { "type": "string", "description": "Event type used to classify this timeline, SMS, call, or automation event." }, "eventCategory": { "type": [ "null", "string" ], "description": "High-level category used to group this Leadping event." }, "timelineType": { "allOf": [ { "$ref": "#/components/schemas/EventTimelineType" } ], "description": "Timeline type used to render this event in Leadping activity feeds." }, "timelineCategory": { "type": "string", "description": "Timeline category used to group events for display and filtering." }, "description": { "type": "string", "description": "Human-readable description that explains this event timeline table row to API users." }, "conversationId": { "type": [ "null", "string" ], "description": "Conversation ID that links this event timeline table row to the Leadping inbox thread." }, "leadId": { "type": [ "null", "string" ], "description": "Lead ID associated with this timeline event." }, "relatedEntityType": { "type": [ "null", "string" ], "description": "Related entity type connected to this event or notification." }, "relatedEntityId": { "type": [ "null", "string" ], "description": "Related entity ID connected to this event or notification." }, "summary": { "type": [ "null", "string" ], "description": "Short human-readable summary of this event timeline table row for lists, timelines, and notifications." }, "media": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/MessageMediaAttachment" } ], "description": "Media attached to an SMS/MMS conversation event." }, "description": "Media attached to an MMS timeline event." }, "direction": { "type": [ "null", "string" ], "description": "Communication direction for this event timeline table row, such as inbound or outbound." }, "status": { "enum": [ "Pending", "InProgress", "Completed", "Cancelled", "Scheduled", "Queued", "Sending", "Sent", "Received", "Delivered", "Undeliverable", "Opted out", "Blocked", "Initiated", "Ringing", "Active", "Ended", "Missed", "Voicemail", "Failed", "Canceled" ], "type": [ "null", "string" ], "description": "Provides the customer-facing outcome shown for an item in a lead or conversation timeline." }, "statusReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining the current status of this event timeline table row." }, "trafficType": { "enum": [ "RealLead", "Warmup", "Test", "SystemInternal", "FailedAttempt" ], "type": [ "null", "string" ], "description": "Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose." }, "fromPhoneNumberId": { "type": [ "null", "string" ], "description": "Sender phone number ID used for this outbound SMS or call." }, "outboundPhoneNumberId": { "type": [ "null", "string" ], "description": "Phone number ID selected for outbound delivery." }, "fromPhoneNumber": { "type": [ "null", "string" ], "description": "Sender phone number used for this communication." }, "toPhoneNumber": { "type": [ "null", "string" ], "description": "Recipient phone number used for this communication." }, "selectionReason": { "enum": [ "StickyConversation", "LeadAssigned", "CampaignOrSource", "Preferred", "LocalArea", "HealthyPool", "FallbackDefault", "ManualOverride" ], "type": [ "null", "string" ], "description": "Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number." }, "wasManuallyOverridden": { "type": "boolean", "description": "Indicates whether a user manually overrode Leadping's automatic number selection for this event timeline table row." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this event timeline table row." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID used for event attribution." }, "complianceAction": { "type": [ "null", "string" ], "description": "Compliance action applied to this message, lead, or sender." }, "billingStatus": { "type": [ "null", "string" ], "description": "Billing state for this communication, charge, or transaction." }, "billableAmount": { "type": [ "null", "number" ], "description": "Monetary amount billed for this Leadping communication or transaction.", "format": "double" }, "errorCode": { "type": [ "null", "string" ], "description": "Machine-readable error code returned while processing this event timeline table row." }, "retryCount": { "type": "integer", "description": "Number of retry attempts already made for this event timeline table row.", "format": "int32" }, "queuedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping queued this event timeline table row for processing.", "format": "date-time" }, "sendingStartedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping began sending this message.", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping sent this message to the provider.", "format": "date-time" }, "deliveredAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider confirmed delivery.", "format": "date-time" }, "receivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping received this inbound event or message.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when processing failed for this event timeline table row.", "format": "date-time" }, "undeliverableAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider marked the message undeliverable.", "format": "date-time" }, "blockedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping blocked this communication.", "format": "date-time" }, "nextRetryAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping will retry this event timeline table row.", "format": "date-time" }, "scheduledFor": { "type": [ "null", "string" ], "description": "UTC timestamp when the related delivery or workflow action is scheduled to run.", "format": "date-time" }, "scheduledReason": { "type": [ "null", "string" ], "description": "Reason Leadping scheduled this delivery for a later time." }, "canceledAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this delivery or workflow was canceled.", "format": "date-time" }, "cancelReason": { "type": [ "null", "string" ], "description": "Reason this delivery, run, or request was canceled." }, "createdAt": { "type": "string", "description": "UTC timestamp when this event timeline table row was created.", "format": "date-time" }, "createdBy": { "type": "string", "description": "Display name or identifier for the person or system that created this event timeline table row." }, "actorUserId": { "type": [ "null", "string" ], "description": "User ID for the person or system that created this event timeline table row." }, "actorDisplayName": { "type": [ "null", "string" ], "description": "Display name for the person or system that created this event timeline table row." }, "actorEmail": { "type": [ "null", "string" ], "description": "Email address for the person who created this event timeline table row.", "format": "email" } }, "description": "Summarizes event timeline data in paginated and searchable results." }, "EventTimelineType": { "enum": [ "Message", "Sms", "Mms", "Call", "Voicemail", "Note", "LeadStatusChange", "LeadCreated", "LeadUpdated", "Notification", "Payment", "Warmup" ], "type": "string", "description": "Classifies the kind of activity displayed in a lead or conversation event timeline." }, "ExactMatchFilter": { "type": "object", "properties": { "value": { "description": "Scalar value the target field must equal; its JSON type should match the field being queried." }, "field": { "type": "string", "description": "Serializable field name to evaluate; supported names are determined by the queried resource." } }, "description": "Selects records whose named field equals a supplied scalar value." }, "FeedbackCreateRequest": { "type": "object", "properties": { "type": { "enum": [ "bug", "confusing", "feature_request", "missing_capability", "other" ], "type": [ "null", "string" ], "description": "Defines the type of product feedback submitted from inside Leadping." }, "message": { "type": [ "null", "string" ], "description": "Message text supplied by the user or returned by the Leadping API for this feedback creation request." }, "route": { "type": [ "null", "string" ], "description": "Application route where this feedback creation request originated or should direct the user." }, "area": { "type": [ "null", "string" ], "description": "Product area or app section connected to this feedback creation request." }, "allowContact": { "type": "boolean", "description": "Indicates whether the submitter permits Leadping support to contact them about the feedback." }, "clientVersion": { "type": [ "null", "string" ], "description": "Client application version that submitted this feedback creation request." } }, "description": "Defines the fields clients can send when working with feedback creation." }, "FeedbackResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this feedback item response." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID connected to the feedback item, when the feedback came from an organization workspace." }, "userId": { "type": [ "null", "string" ], "description": "User ID for the person who submitted the feedback." }, "type": { "allOf": [ { "$ref": "#/components/schemas/FeedbackType" } ], "description": "Type classification used to route and interpret this feedback item response in the Leadping API." }, "status": { "allOf": [ { "$ref": "#/components/schemas/FeedbackStatus" } ], "description": "Current lifecycle status for this feedback item response in the Leadping API." }, "area": { "type": [ "null", "string" ], "description": "Product area or app section connected to this feedback item response." }, "route": { "type": [ "null", "string" ], "description": "Application route where this feedback item response originated or should direct the user." }, "message": { "type": "string", "description": "Message text supplied by the user or returned by the Leadping API for this feedback item response." }, "allowContact": { "type": "boolean", "description": "Indicates whether the submitter permits Leadping support to contact them about the feedback." }, "clientVersion": { "type": [ "null", "string" ], "description": "Client application version that submitted this feedback item response." }, "createdAt": { "type": "string", "description": "UTC timestamp when this feedback item response was created.", "format": "date-time" } }, "description": "Describes feedback item data returned by Leadping." }, "FeedbackStatus": { "enum": [ "new", "reviewed", "planned", "in_progress", "shipped", "closed", "ignored" ], "type": "string", "description": "Defines admin triage statuses for durable product feedback." }, "FeedbackType": { "enum": [ "bug", "confusing", "feature_request", "missing_capability", "other" ], "type": "string", "description": "Defines the type of product feedback submitted from inside Leadping." }, "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." }, "IdNameValue": { "required": [ "id", "name" ], "type": "object", "properties": { "value": { "type": [ "null", "string" ], "description": "Optional machine-readable or display value associated with the referenced resource." }, "id": { "type": "string", "description": "Stable unique identifier of the referenced resource." }, "name": { "type": "string", "description": "Human-readable display name of the referenced resource." } }, "description": "Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata." }, "InitiateCallRequest": { "required": [ "leadId" ], "type": "object", "properties": { "fromPhoneNumberId": { "type": [ "null", "string" ], "description": "Sender phone number ID used for this outbound SMS or call." }, "conversationId": { "type": [ "null", "string" ], "description": "Conversation ID that links this phone call initiation request to the Leadping inbox thread." }, "leadId": { "type": "string", "description": "Lead ID associated with the outbound call request." }, "wasManuallyOverridden": { "type": "boolean", "description": "Indicates whether a user manually overrode Leadping's automatic number selection for this phone call initiation request." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this phone call initiation request." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID used for call attribution and sender selection." }, "outboundIdempotencyKey": { "type": [ "null", "string" ], "description": "Idempotency key used to prevent duplicate outbound delivery." } }, "description": "Defines the fields clients can send when working with phone call initiation.", "example": { "leadId": "lead-123", "conversationId": "conversation-123", "wasManuallyOverridden": false, "outboundIdempotencyKey": "call-example-001" } }, "InvoicePdfAccessResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "Short-lived URL that can be used to download the invoice PDF.", "format": "uri" }, "expiresAt": { "type": "string", "description": "Date and time after which the download URL is no longer valid.", "format": "date-time" } }, "description": "Short-lived access details for a private Leadping invoice PDF." }, "LeadArchiveReason": { "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" }, "LeadArchiveRequest": { "type": "object", "properties": { "reason": { "allOf": [ { "$ref": "#/components/schemas/LeadArchiveReason" } ], "description": "Human-readable reason supplied for this request or result." }, "note": { "maxLength": 500, "type": [ "null", "string" ], "description": "Optional archive note that gives additional context for why the lead was archived." } }, "description": "Defines the fields clients can send when working with lead archive." }, "LeadAssignmentRequest": { "type": "object", "properties": { "assignedToUserId": { "type": [ "null", "string" ], "description": "Gets or sets the assigned to user ID." } }, "description": "Assigns an organization lead to an active organization member. A null user ID returns the lead to the unassigned queue." }, "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." }, "LeadIntakeRequest": { "type": "object", "properties": { "firstName": { "type": [ "null", "string" ], "description": "First name of the lead, user, or contact represented by this lead intake request." }, "lastName": { "type": [ "null", "string" ], "description": "Last name of the lead, user, or contact represented by this lead intake request." }, "email": { "type": [ "null", "string" ], "description": "Email address for the person represented by this lead intake request.", "format": "email" }, "phone": { "type": [ "null", "string" ], "description": "Phone details for the lead, user, or organization represented by this lead intake request." }, "phoneType": { "type": [ "null", "string" ], "description": "Source-provided phone type, such as mobile, landline, or VoIP, used during lead intake normalization." }, "dateOfBirth": { "type": [ "null", "string" ], "description": "Lead date of birth supplied by intake sources and normalized into the lead profile.", "format": "date" }, "birthDate": { "type": [ "null", "string" ], "description": "Lead birth date used for demographic matching and insurance intake workflows.", "format": "date" }, "address1": { "type": [ "null", "string" ], "description": "First street address line submitted by the lead intake source." }, "address2": { "type": [ "null", "string" ], "description": "Second street address line submitted by the lead intake source." }, "city": { "type": [ "null", "string" ], "description": "City for the lead or organization postal address." }, "state": { "type": [ "null", "string" ], "description": "State, province, or region for the lead or organization postal address." }, "zip": { "type": [ "null", "string" ], "description": "ZIP code submitted by the lead intake source." }, "postalCode": { "type": [ "null", "string" ], "description": "Postal code for the lead or organization address." }, "gender": { "type": [ "null", "string" ], "description": "Lead gender supplied by intake sources and normalized when possible." }, "subId": { "type": [ "null", "string" ], "description": "Affiliate or publisher sub ID captured for lead attribution." }, "sellerLeadId": { "type": [ "null", "string" ], "description": "Seller-provided lead identifier used to deduplicate and reconcile lead delivery." }, "sellerLeadIdentifier": { "type": [ "null", "string" ], "description": "Alternate seller-provided lead identifier used during intake normalization." }, "directPostPrice": { "type": [ "null", "number" ], "description": "Direct-post price supplied by the lead source during intake.", "format": "double" }, "price": { "type": [ "null", "number" ], "description": "Lead price or transaction price supplied to the Leadping API.", "format": "double" }, "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." }, "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." }, "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." }, "trustedFormUrl": { "type": [ "null", "string" ], "description": "TrustedForm certificate URL used as proof of consumer consent.", "format": "uri" }, "externalId": { "type": [ "null", "string" ], "description": "External system identifier used to reconcile this lead intake request across integrations." }, "sourceMetadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Source-provided key-value metadata retained for lead attribution and integration troubleshooting." }, "tagIds": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs assigned to or filtered against this lead." }, "tagNames": { "type": "array", "items": { "type": "string" }, "description": "Tag names assigned to this lead when matching existing tags by name." } }, "description": "Defines the fields clients can send when working with lead intake.", "example": { "firstName": "Taylor", "lastName": "Morgan", "email": "taylor@example.com", "phone": "+13125550100", "utmSource": "paid-search", "utmCampaign": "summer-campaign", "landingPage": "https://example.com/request-a-quote", "externalId": "external-lead-123", "tagNames": [ "website", "new-lead" ] } }, "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." }, "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." }, "LeadRequest": { "required": [ "metadata", "contact", "customer", "tagIds", "tagNames" ], "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/LeadMetadata" } ], "description": "Structured metadata used for attribution, integrations, and reporting on this lead request." }, "contact": { "allOf": [ { "$ref": "#/components/schemas/LeadContact" } ], "description": "Contact details for the lead or customer represented by this lead request." }, "customer": { "allOf": [ { "$ref": "#/components/schemas/LeadProfile" } ], "description": "Demographic profile details for the lead represented by this lead request." }, "enabled": { "type": [ "null", "boolean" ], "description": "Indicates whether this lead request is active and available in the Leadping API." }, "tagIds": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs assigned to or filtered against this lead." }, "tagNames": { "type": "array", "items": { "type": "string" }, "description": "Tag names assigned to this lead when matching existing tags by name." }, "id": { "type": [ "null", "string" ], "description": "Stable unique identifier of an existing resource to update; omit it when the API assigns an identifier during creation." } }, "description": "Defines the fields clients can send when working with lead." }, "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." }, "LeadStatusCategory": { "enum": [ "Open", "Qualified", "Converted", "Lost", "Invalid", "Duplicate" ], "type": "string", "description": "Controlled lead status change categories used for reporting, automation, and analytics." }, "LeadStatusChangeExportResponse": { "type": "object", "properties": { "fileName": { "type": "string", "description": "Suggested file name for the exported CSV document." }, "contentType": { "type": "string", "description": "MIME content type of the exported document." }, "csv": { "type": "string", "description": "Complete comma-separated values content encoded as text." }, "rows": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeExportRow" } ], "description": "Describes lead status change export row data returned by Leadping." }, "description": "The rows included with this lead status change export." } }, "description": "Describes lead status change export data returned by Leadping." }, "LeadStatusChangeExportRow": { "type": "object", "properties": { "leadId": { "type": [ "null", "string" ], "description": "The lead ID associated with this lead status change export row." }, "leadStatusChangeId": { "type": [ "null", "string" ], "description": "The lead status change ID associated with this lead status change export row." }, "type": { "type": [ "null", "string" ], "description": "Category of status change represented by this exported row." }, "outcome": { "type": [ "null", "string" ], "description": "Result of the interaction or workflow step represented by this exported row." }, "category": { "enum": [ "Open", "Qualified", "Converted", "Lost", "Invalid", "Duplicate" ], "type": [ "null", "string" ], "description": "Controlled lead status change categories used for reporting, automation, and analytics." }, "oldLeadStatusChangeId": { "type": [ "null", "string" ], "description": "Unique identifier of the old lead status change associated with this Leadping lead status change export row." }, "oldLeadStatusChangeType": { "type": [ "null", "string" ], "description": "Old lead status change type classification for this Leadping lead status change export row." }, "oldLeadStatusChangeOutcome": { "type": [ "null", "string" ], "description": "Old lead status change outcome associated with this Leadping lead status change export row." }, "newLeadStatusChangeId": { "type": [ "null", "string" ], "description": "Unique identifier of the new lead status change associated with this Leadping lead status change export row." }, "changeSource": { "enum": [ "User", "AI", "Automation", "System", "API" ], "type": [ "null", "string" ], "description": "Known sources that can change a lead's current lead status change." }, "changedByUserId": { "type": [ "null", "string" ], "description": "Unique identifier of the Leadping user who made the change." }, "changedByAutomationId": { "type": [ "null", "string" ], "description": "Unique identifier of the automation that changed the lead status change, when applicable." }, "changedAt": { "type": [ "null", "string" ], "description": "Date and time when the lead status change change occurred.", "format": "date-time" }, "reason": { "type": [ "null", "string" ], "description": "Human-readable explanation for the current lead status change export row outcome." }, "followUpStatus": { "type": [ "null", "string" ], "description": "The current follow up status for this lead status change export row." }, "callbackAt": { "type": [ "null", "string" ], "description": "UTC timestamp for callback at on this lead status change export row.", "format": "date-time" }, "taskDueAt": { "type": [ "null", "string" ], "description": "UTC timestamp for task due at on this lead status change export row.", "format": "date-time" }, "appointmentStartAt": { "type": [ "null", "string" ], "description": "UTC timestamp for appointment start at on this lead status change export row.", "format": "date-time" }, "appointmentEndAt": { "type": [ "null", "string" ], "description": "UTC timestamp for appointment end at on this lead status change export row.", "format": "date-time" }, "assignedToUserId": { "type": [ "null", "string" ], "description": "The assigned to user ID associated with this lead status change export row." }, "sourceId": { "type": [ "null", "string" ], "description": "The source ID associated with this lead status change export row." }, "relatedCallEventId": { "type": [ "null", "string" ], "description": "The related call event ID associated with this lead status change export row." }, "isMissedCallFollowUp": { "type": "boolean", "description": "Whether this lead status change export row is missed call follow up." }, "notes": { "type": [ "null", "string" ], "description": "The operator or customer notes recorded for this lead status change export row." }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this lead status change export row.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "UTC timestamp for updated at on this lead status change export row.", "format": "date-time" } }, "description": "Describes lead status change export row data returned by Leadping." }, "LeadStatusChangeRequest": { "required": [ "type", "outcome" ], "type": "object", "properties": { "type": { "type": "string", "description": "Category of status change being recorded for the lead." }, "outcome": { "type": "string", "description": "Result of the interaction or workflow step that caused the status change." }, "category": { "enum": [ "Open", "Qualified", "Converted", "Lost", "Invalid", "Duplicate" ], "type": [ "null", "string" ], "description": "Controlled lead status change categories used for reporting, automation, and analytics." }, "notes": { "type": [ "null", "string" ], "description": "The operator or customer notes recorded for this lead status change." }, "reason": { "type": [ "null", "string" ], "description": "The reason this lead status change was changed." }, "followUpStatus": { "type": [ "null", "string" ], "description": "The current follow up status for this lead status change." }, "callbackAt": { "type": [ "null", "string" ], "description": "UTC timestamp for callback at on this lead status change.", "format": "date-time" }, "taskDueAt": { "type": [ "null", "string" ], "description": "UTC timestamp for task due at on this lead status change.", "format": "date-time" }, "appointmentStartAt": { "type": [ "null", "string" ], "description": "UTC timestamp for appointment start at on this lead status change.", "format": "date-time" }, "appointmentEndAt": { "type": [ "null", "string" ], "description": "UTC timestamp for appointment end at on this lead status change.", "format": "date-time" }, "appointmentNotes": { "type": [ "null", "string" ], "description": "Additional scheduling or preparation notes for the related appointment." } }, "description": "Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context." }, "LeadStatusChangeResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this lead status change." }, "leadId": { "type": "string", "description": "The lead ID associated with this lead status change." }, "leadName": { "type": [ "null", "string" ], "description": "The display name of the lead associated with this lead status change." }, "type": { "type": "string", "description": "Category of status change recorded for the lead." }, "outcome": { "type": "string", "description": "Result of the interaction or workflow step that caused the status change." }, "category": { "enum": [ "Open", "Qualified", "Converted", "Lost", "Invalid", "Duplicate" ], "type": [ "null", "string" ], "description": "Controlled lead status change categories used for reporting, automation, and analytics." }, "oldLeadStatusChangeId": { "type": [ "null", "string" ], "description": "Unique identifier of the old lead status change associated with this Leadping lead status change." }, "oldLeadStatusChangeType": { "type": [ "null", "string" ], "description": "Old lead status change type classification for this Leadping lead status change." }, "oldLeadStatusChangeOutcome": { "type": [ "null", "string" ], "description": "Old lead status change outcome associated with this Leadping lead status change." }, "newLeadStatusChangeId": { "type": [ "null", "string" ], "description": "Unique identifier of the new lead status change associated with this Leadping lead status change." }, "notes": { "type": "string", "description": "The operator or customer notes recorded for this lead status change." }, "reason": { "type": [ "null", "string" ], "description": "The reason this lead status change was changed." }, "changedByUserId": { "type": [ "null", "string" ], "description": "Unique identifier of the Leadping user who made the change." }, "changedByAutomationId": { "type": [ "null", "string" ], "description": "Unique identifier of the automation that changed the lead status change, when applicable." }, "changedAt": { "type": [ "null", "string" ], "description": "Date and time when the lead status change change occurred.", "format": "date-time" }, "changeSource": { "enum": [ "User", "AI", "Automation", "System", "API" ], "type": [ "null", "string" ], "description": "Known sources that can change a lead's current lead status change." }, "timestamp": { "type": "string", "description": "UTC timestamp for timestamp on this lead status change.", "format": "date-time" }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this lead status change.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "UTC timestamp for updated at on this lead status change.", "format": "date-time" }, "followUpStatus": { "type": [ "null", "string" ], "description": "The current follow up status for this lead status change." }, "callbackAt": { "type": [ "null", "string" ], "description": "UTC timestamp for callback at on this lead status change.", "format": "date-time" }, "taskDueAt": { "type": [ "null", "string" ], "description": "UTC timestamp for task due at on this lead status change.", "format": "date-time" }, "appointmentStartAt": { "type": [ "null", "string" ], "description": "UTC timestamp for appointment start at on this lead status change.", "format": "date-time" }, "appointmentEndAt": { "type": [ "null", "string" ], "description": "UTC timestamp for appointment end at on this lead status change.", "format": "date-time" }, "appointmentNotes": { "type": [ "null", "string" ], "description": "Additional scheduling or preparation notes for the related appointment." }, "assignedToUserId": { "type": [ "null", "string" ], "description": "The assigned to user ID associated with this lead status change." }, "relatedCallEventId": { "type": [ "null", "string" ], "description": "The related call event ID associated with this lead status change." }, "isMissedCallFollowUp": { "type": "boolean", "description": "Whether this lead status change is missed call follow up." }, "sourceId": { "type": [ "null", "string" ], "description": "The source ID associated with this lead status change." } }, "description": "Describes an auditable lead status transition, including the previous and new status, source, actor, and effective time." }, "LeadStatusRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Display name for the lead status." }, "color": { "type": [ "null", "string" ], "description": "Display color for the lead status." }, "category": { "enum": [ "Open", "Qualified", "Converted", "Lost", "Invalid", "Duplicate" ], "type": [ "null", "string" ], "description": "Controlled lead status change categories used for reporting, automation, and analytics." }, "sortOrder": { "type": [ "null", "integer" ], "description": "Relative display order for the lead status.", "format": "int32" } }, "description": "Defines the editable values used to create or update a lead status." }, "LeadStatusResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the lead status." }, "organizationId": { "type": "string", "description": "Identifier of the organization that owns the lead status." }, "name": { "type": "string", "description": "Display name of the lead status." }, "color": { "type": "string", "description": "Display color assigned to the lead status." }, "category": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusCategory" } ], "description": "LeadStatusChange category represented by the lead status." }, "sortOrder": { "type": "integer", "description": "Relative display order of the lead status.", "format": "int32" }, "isArchived": { "type": "boolean", "description": "Indicates whether the lead status has been archived." }, "modifiedAt": { "type": "string", "description": "Date and time when the lead status was last modified.", "format": "date-time" } }, "description": "Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes." }, "LeadTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this lead table row." }, "assignedToUserId": { "type": [ "null", "string" ], "description": "Leadping user currently responsible for this lead, or null when unassigned." }, "assignedTo": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the assigned organization member." }, "firstName": { "type": [ "null", "string" ], "description": "First name of the lead, user, or contact represented by this lead table row." }, "lastName": { "type": [ "null", "string" ], "description": "Last name of the lead, user, or contact represented by this lead table row." }, "phone": { "type": "string", "description": "Phone details for the lead, user, or organization represented by this lead table row." }, "phoneIdentityId": { "type": [ "null", "string" ], "description": "Identifier of the canonical phone identity associated with this lead's phone number." }, "email": { "type": "string", "description": "Email address for the person represented by this lead table row.", "format": "email" }, "avatarUrl": { "type": [ "null", "string" ], "description": "Optional profile image URL explicitly associated with the lead.", "format": "uri" }, "createdAt": { "type": "string", "description": "UTC timestamp when this lead table row was created.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "UTC timestamp when this lead table row was last updated.", "format": "date-time" }, "status": { "type": "string", "description": "Current lifecycle status for this lead table row in the Leadping API." }, "statusTone": { "type": "string", "description": "Presentation tone that helps clients style the current status of this lead table row." }, "enabled": { "type": "boolean", "description": "Indicates whether this lead table row is active and available in the Leadping API." }, "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" }, "isArchived": { "type": "boolean", "description": "Whether this lead is archived." }, "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" }, "price": { "type": [ "null", "number" ], "description": "Lead price or transaction price supplied to the Leadping API.", "format": "double" }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related organization." }, "source": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related source." }, "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." } }, "description": "Summarizes lead data in paginated and searchable results." }, "LeadTagsRequest": { "required": [ "tagIds", "tagNames" ], "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs assigned to or filtered against this lead." }, "tagNames": { "type": "array", "items": { "type": "string" }, "description": "Tag names assigned to this lead when matching existing tags by name." }, "createMissing": { "type": "boolean", "description": "Indicates whether Leadping should create missing records while processing the request." } }, "description": "Defines the fields clients can send when working with lead tag update." }, "MessageMediaAttachment": { "type": "object", "properties": { "url": { "type": "string", "description": "URL from which the media attachment can be retrieved.", "format": "uri" }, "contentType": { "type": [ "null", "string" ], "description": "MIME content type of the media attachment." }, "size": { "type": [ "null", "integer" ], "description": "Size of the media attachment in bytes.", "format": "int64" }, "sha256": { "type": [ "null", "string" ], "description": "SHA-256 digest of the media content, when available." }, "fileName": { "type": [ "null", "string" ], "description": "Original file name of the media attachment, when available." } }, "description": "Media attached to an SMS/MMS conversation event." }, "MobileDevicePreferences": { "type": "object", "properties": { "device": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related device." }, "inboundPhoneCallsEnabled": { "type": "boolean", "description": "Whether inbound phone calls are enabled for this user device." }, "updatedAt": { "type": [ "null", "string" ], "description": "The date and time this device preference was last updated.", "format": "date-time" } }, "description": "Describes notification and calling preferences saved for one of the user's mobile devices." }, "NotificationPriority": { "enum": [ "Low", "Medium", "High", "Critical" ], "type": "string", "description": "Ranks the urgency and presentation importance of a Leadping user notification." }, "NotificationResponse": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/NotificationType" } ], "description": "The type classification for this notification." }, "priority": { "allOf": [ { "$ref": "#/components/schemas/NotificationPriority" } ], "description": "Priority for this notification." }, "userId": { "type": "string", "description": "The user ID associated with this notification." }, "message": { "type": "string", "description": "Message for this notification." }, "details": { "type": [ "null", "string" ], "description": "Optional supporting details displayed beneath the notification message." }, "readAt": { "type": [ "null", "string" ], "description": "UTC timestamp for read at on this notification.", "format": "date-time" }, "isRead": { "type": "boolean", "description": "Whether this notification is read." }, "pushEnabled": { "type": "boolean", "description": "Whether this notification should also be delivered as a device push notification." }, "actionUrl": { "type": [ "null", "string" ], "description": "The URL associated with this notification." }, "actionButtonText": { "type": [ "null", "string" ], "description": "Action button text for this notification." }, "relatedEntityId": { "type": [ "null", "string" ], "description": "The related entity ID associated with this notification." }, "relatedEntityType": { "type": [ "null", "string" ], "description": "The related entity type classification for this notification." }, "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 notification data used in Leadping API requests and responses." }, "NotificationTableRow": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/NotificationType" } ], "description": "The type classification for this notification." }, "priority": { "allOf": [ { "$ref": "#/components/schemas/NotificationPriority" } ], "description": "Priority for this notification." }, "message": { "type": "string", "description": "Message for this notification." }, "details": { "type": [ "null", "string" ], "description": "Optional supporting details displayed beneath the notification message." }, "isRead": { "type": "boolean", "description": "Whether this notification is read." }, "readAt": { "type": [ "null", "string" ], "description": "UTC timestamp for read at on this notification.", "format": "date-time" }, "actionUrl": { "type": [ "null", "string" ], "description": "The URL associated with this notification." }, "actionButtonText": { "type": [ "null", "string" ], "description": "Action button text for this notification." }, "relatedEntityId": { "type": [ "null", "string" ], "description": "The related entity ID associated with this notification." }, "relatedEntityType": { "type": [ "null", "string" ], "description": "The related entity type classification for this notification." }, "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 notification data returned by Leadping." }, "NotificationType": { "enum": [ "General", "Lead", "Call", "Sms", "Billing", "System", "Success", "Warning", "Error", "Info", "Announcement", "Activation" ], "type": "string", "description": "Identifies the Leadping workflow or account event communicated by a user notification." }, "OrderByOption": { "type": "object", "properties": { "field": { "type": "string", "description": "Serializable field name used for sorting; supported names are determined by the queried resource." }, "direction": { "enum": [ "asc", "desc" ], "type": [ "null", "string" ], "description": "Identifies whether query results are ordered from lower to higher values or from higher to lower values." } }, "description": "Defines one field and direction used to order an API query result set." }, "OrganizationActivationState": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/CustomerActivationStatus" } ], "description": "The current status for this organization activation state." }, "onboardingStatus": { "allOf": [ { "$ref": "#/components/schemas/ActivationOnboardingStatus" } ], "description": "The current onboarding status for this organization activation state." }, "paymentStatus": { "allOf": [ { "$ref": "#/components/schemas/ActivationPaymentStatus" } ], "description": "The current payment status for this organization activation state." }, "billingSubscriptionStatus": { "allOf": [ { "$ref": "#/components/schemas/ActivationSubscriptionStatus" } ], "description": "The current billing subscription status for this organization activation state." }, "launchReviewStatus": { "allOf": [ { "$ref": "#/components/schemas/ActivationLaunchReviewStatus" } ], "description": "The current launch review status for this organization activation state." }, "controlledLaunch": { "type": "boolean", "description": "Whether controlled launch applies to this organization activation state." }, "telephonyStatus": { "allOf": [ { "$ref": "#/components/schemas/ActivationTelephonyStatus" } ], "description": "The current telephony status for this organization activation state." }, "websiteStatus": { "allOf": [ { "$ref": "#/components/schemas/WebsiteLifecycleStatus" } ], "description": "The current website status for this organization activation state." }, "tenDlcStatus": { "allOf": [ { "$ref": "#/components/schemas/TenDlcApplicationStatus" } ], "description": "The current 10DLC status for this organization activation state." }, "tenDlcApplicationId": { "type": [ "null", "string" ], "description": "Identifier of the first-class 10DLC application entity for this organization." }, "customerFacingStatus": { "type": "string", "description": "The current customer facing status for this organization activation state." }, "paymentMethodConfirmedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for payment method confirmed at on this organization activation state.", "format": "date-time" }, "subscriptionPendingAt": { "type": [ "null", "string" ], "description": "UTC timestamp for subscription pending at on this organization activation state.", "format": "date-time" }, "subscriptionActiveAt": { "type": [ "null", "string" ], "description": "UTC timestamp for subscription active at on this organization activation state.", "format": "date-time" }, "launchReviewRequestedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for launch review requested at on this organization activation state.", "format": "date-time" }, "launchApprovedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for launch approved at on this organization activation state.", "format": "date-time" }, "telephonyProvisioningStartedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for telephony provisioning started at on this organization activation state.", "format": "date-time" }, "telephonyPartiallyProvisionedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for telephony partially provisioned at on this organization activation state.", "format": "date-time" }, "telephonyReadyAt": { "type": [ "null", "string" ], "description": "UTC timestamp for telephony ready at on this organization activation state.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for failed at on this organization activation state.", "format": "date-time" }, "activatedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for activated at on this organization activation state.", "format": "date-time" }, "industry": { "type": [ "null", "string" ], "description": "Industry for this organization activation state." }, "organizationDescription": { "type": [ "null", "string" ], "description": "Organization description for this organization activation state." }, "targetAudience": { "type": [ "null", "string" ], "description": "Target audience for this organization activation state." }, "offer": { "type": [ "null", "string" ], "description": "Offer for this organization activation state." }, "websiteNeeds": { "type": [ "null", "string" ], "description": "Website needs for this organization activation state." }, "serviceArea": { "type": [ "null", "string" ], "description": "Service area for this organization activation state." }, "complianceNotes": { "type": [ "null", "string" ], "description": "Compliance notes for this organization activation state." }, "domainOptions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ActivationDomainOption" } ], "description": "Describes activation domain option data used in Leadping API requests and responses." }, "description": "The domain options included with this organization activation state." }, "domainSearchStage": { "enum": [ "Queued", "AskingOpenAi", "CheckingCloudflare", "Ranking", "Complete", "Failed" ], "type": [ "null", "string" ], "description": "Defines the stages of a domain search." }, "domainSearchId": { "type": [ "null", "string" ], "description": "Identifies the active domain search run." }, "domainSearchAttempt": { "type": "integer", "description": "The current domain generation attempt.", "format": "int32" }, "availableDomainCount": { "type": "integer", "description": "The number of registrar-verified domains found by the current search.", "format": "int32" }, "domainSearchUpdatedAt": { "type": [ "null", "string" ], "description": "The last time domain search progress changed.", "format": "date-time" }, "selectedDomain": { "type": [ "null", "string" ], "description": "Selected domain for this organization activation state." }, "domainApprovedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for domain approved at on this organization activation state.", "format": "date-time" }, "domainPurchasedAt": { "type": [ "null", "string" ], "description": "The date and time the selected domain was purchased.", "format": "date-time" }, "websiteGenerationResult": { "type": [ "null", "string" ], "description": "The latest persisted website generation progress message." }, "websiteUrl": { "type": [ "null", "string" ], "description": "The URL associated with this organization activation state.", "format": "uri" }, "tenDlcDraft": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/TenDlcApplicationDraft" } ], "description": "10DLC draft for this organization activation state." }, "events": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ActivationTimelineEvent" } ], "description": "Describes activation timeline event data used in Leadping API requests and responses." }, "description": "The events included with this organization activation state." }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this organization activation state.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "UTC timestamp for updated at on this organization activation state.", "format": "date-time" } }, "description": "Describes organization activation state data used in Leadping API requests and responses." }, "OrganizationApiKeyIssueResponse": { "type": "object", "properties": { "secret": { "type": "string", "description": "Secret token returned once when the Leadping API key is issued." }, "expiresAt": { "type": [ "null", "string" ], "description": "Date and time when the organization API key issue expires.", "format": "date-time" }, "apiKey": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyPreviewResponse" } ], "description": "API key associated with this Leadping organization API key issue." } }, "description": "Returns a newly issued organization API key and its identifying metadata; the secret credential is shown only in this response." }, "OrganizationApiKeyListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/OrganizationApiKeyPreviewResponse" } ], "description": "Safe identifying and usage metadata for an organization API key. This model never contains the secret credential." }, "description": "Safe API-key previews in the current page." }, "pageSize": { "type": "integer", "description": "Number of API keys in the current page.", "format": "int32" }, "totalCount": { "type": "integer", "description": "Total number of API keys matching the request.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque token for retrieving the next page, or null when this is the last page." } }, "description": "A page of safe organization API-key previews." }, "OrganizationApiKeyPreviewResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the API key." }, "name": { "type": "string", "description": "Human-readable name of the API key." }, "organization": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Organization that owns the API key." }, "enabled": { "type": "boolean", "description": "Whether the API key can currently authenticate requests." }, "preview": { "type": [ "null", "string" ], "description": "Masked value that can be used to identify the key without revealing its secret." }, "permissions": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Permission slugs granted to the API key." }, "issuedAt": { "type": [ "null", "string" ], "description": "Date and time when the API key was issued.", "format": "date-time" }, "firstUsedAt": { "type": [ "null", "string" ], "description": "Date and time when the API key was first used.", "format": "date-time" }, "lastUsedAt": { "type": [ "null", "string" ], "description": "Date and time when the API key was last used.", "format": "date-time" }, "expiresAt": { "type": [ "null", "string" ], "description": "Date and time when the API key expires, or null when it does not expire.", "format": "date-time" }, "totalUses": { "type": "integer", "description": "Total number of tracked uses.", "format": "int64" }, "createdAt": { "type": "string", "description": "Date and time when Leadping began tracking the API key.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Date and time when the tracked API-key metadata was last modified.", "format": "date-time" } }, "description": "Safe identifying and usage metadata for an organization API key. This model never contains the secret credential." }, "OrganizationApiKeyRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Human-readable name used to identify the key." }, "expiresInDays": { "type": [ "null", "integer" ], "description": "Number of days before the key expires. Null means no expiration.", "format": "int32" }, "permissions": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "WorkOS permission slugs granted to the API key." } }, "description": "Defines the display name and access configuration for a new Leadping organization API key." }, "OrganizationApiKeyRevokeResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the revoked API key." }, "revokedAt": { "type": "string", "description": "Date and time when the API key was revoked.", "format": "date-time" } }, "description": "Confirms that an organization API key was revoked." }, "OrganizationBillingState": { "type": "object", "properties": { "hasStripeCustomer": { "type": "boolean", "description": "Indicates whether the organization has a Stripe customer account." }, "hasPaymentMethod": { "type": "boolean", "description": "Indicates whether the organization has a saved default payment method." }, "phoneNumberQuantity": { "type": [ "null", "integer" ], "description": "Number of phone numbers included in the organization's subscription plan.", "format": "int64" }, "organizationMemberQuantity": { "type": [ "null", "integer" ], "description": "Number of user licenses included in the organization's subscription plan.", "format": "int64" }, "organizationMemberAssignedQuantity": { "type": [ "null", "integer" ], "description": "Number of user licenses currently assigned to organization members.", "format": "int64" }, "pendingBillingPlan": { "enum": [ "Annual", "Monthly" ], "type": [ "null", "string" ], "description": "Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior." }, "billingPlanChangeEffectiveAt": { "type": [ "null", "string" ], "description": "Date and time when the scheduled billing plan change takes effect.", "format": "date-time" }, "planRenewalAt": { "type": [ "null", "string" ], "description": "Current plan renewal date.", "format": "date-time" }, "planPeriodStartAt": { "type": [ "null", "string" ], "description": "Start of the current plan billing period.", "format": "date-time" }, "cancelAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the active subscription is scheduled to cancel.", "format": "date-time" }, "dunning": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/OrganizationDunningInfo" } ], "description": "Customer-safe payment recovery state for the organization." }, "lastSubscriptionEventAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping last processed a subscription event for the organization.", "format": "date-time" }, "lastPaymentMethodEventAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping last processed a payment-method event for the organization.", "format": "date-time" } }, "description": "Customer-safe billing state for a Leadping organization." }, "OrganizationCompliancePolicy": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether this organization compliance policy is enabled." }, "allowedStates": { "type": "array", "items": { "type": "string" }, "description": "The allowed states included with this organization compliance policy." }, "allowedProducts": { "type": "array", "items": { "type": "string" }, "description": "The allowed products included with this organization compliance policy." }, "requireLeadState": { "type": "boolean", "description": "Whether this organization compliance policy requires lead state." }, "requireAgentLicenseState": { "type": "boolean", "description": "Whether this organization compliance policy requires agent license state." }, "requireProduct": { "type": "boolean", "description": "Whether this organization compliance policy requires product." }, "requireTrustedFormForAutomations": { "type": "boolean", "description": "Whether this organization compliance policy requires TrustedForm for automations." }, "requireSourceComplianceApproval": { "type": "boolean", "description": "Whether this organization compliance policy requires source compliance approval." } }, "description": "Describes organization compliance policy data used in Leadping API requests and responses." }, "OrganizationDunningInfo": { "type": "object", "properties": { "stage": { "type": [ "null", "string" ], "description": "Current stage for this Leadping organization dunning info." }, "paymentFailedAt": { "type": [ "null", "string" ], "description": "Date and time when this Leadping organization dunning info was payment failed.", "format": "date-time" }, "lastFailedInvoiceStatus": { "type": [ "null", "string" ], "description": "Current last failed invoice status for this Leadping organization dunning info." }, "retryAttemptCount": { "type": "integer", "description": "Total number of retry attempt records represented by this Leadping organization dunning info.", "format": "int32" }, "nextRetryAt": { "type": [ "null", "string" ], "description": "Date and time when the next retry is scheduled.", "format": "date-time" }, "gracePeriodEndsAt": { "type": [ "null", "string" ], "description": "Date and time when this Leadping organization dunning info was grace period ends.", "format": "date-time" }, "outboundRestrictedAt": { "type": [ "null", "string" ], "description": "Date and time when this Leadping organization dunning info was outbound restricted.", "format": "date-time" }, "outboundSuspendedAt": { "type": [ "null", "string" ], "description": "Date and time when this Leadping organization dunning info was outbound suspended.", "format": "date-time" }, "finalCancellationAt": { "type": [ "null", "string" ], "description": "Date and time when this Leadping organization dunning info was final cancellation.", "format": "date-time" }, "lastUpdatedAt": { "type": [ "null", "string" ], "description": "Date and time when this Leadping organization dunning info was last updated.", "format": "date-time" } }, "description": "Dunning state recorded after a failed recurring payment." }, "OrganizationInvitationRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email address associated with this organization invitation.", "format": "email" }, "role": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRole" } ], "description": "Role for this organization invitation." } }, "description": "Defines the input used for organization invitation." }, "OrganizationInvitationResponse": { "type": "object", "properties": { "safeMessage": { "type": [ "null", "string" ], "description": "Safe message for this organization invitation." }, "id": { "type": "string", "description": "Unique Leadping identifier for this organization invitation." }, "organization": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related organization." }, "email": { "type": "string", "description": "The email address associated with this organization invitation.", "format": "email" }, "role": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRole" } ], "description": "Role for this organization invitation." }, "status": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationStatus" } ], "description": "The current status for this organization invitation." }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this organization invitation.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "UTC timestamp for expires at on this organization invitation.", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "description": "UTC timestamp for sent at on this organization invitation.", "format": "date-time" }, "resentAt": { "type": [ "null", "string" ], "description": "UTC timestamp for resent at on this organization invitation.", "format": "date-time" }, "acceptedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for accepted at on this organization invitation.", "format": "date-time" }, "revokedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for revoked at on this organization invitation.", "format": "date-time" }, "sendFailureReason": { "type": [ "null", "string" ], "description": "The human-readable send failure reason explaining this organization invitation." }, "licenseBillingStatus": { "type": [ "null", "string" ], "description": "The billing status for the paid license created by this invitation." }, "licenseQuantity": { "type": [ "null", "integer" ], "description": "The quantity on the shared organization user license subscription item after this change.", "format": "int64" }, "licenseRenewalDate": { "type": [ "null", "string" ], "description": "The renewal date used for proration of this license.", "format": "date-time" }, "licenseActivatedAt": { "type": [ "null", "string" ], "description": "The date and time this invitation's paid license was created.", "format": "date-time" }, "licenseReleasedAt": { "type": [ "null", "string" ], "description": "The date and time this invitation's paid license was released.", "format": "date-time" } }, "description": "Describes organization invitation data returned by Leadping." }, "OrganizationInvitationStatus": { "enum": [ "Awaiting WorkOS confirmation", "Pending", "Accepted", "Expired", "Revoked", "Resent", "Failed to send" ], "type": "string", "description": "Describes the lifecycle of an organization membership invitation from issuance through acceptance, expiration, or revocation." }, "OrganizationInvitationTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this organization invitation." }, "organization": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related organization." }, "email": { "type": "string", "description": "The email address associated with this organization invitation.", "format": "email" }, "role": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRole" } ], "description": "Role for this organization invitation." }, "status": { "allOf": [ { "$ref": "#/components/schemas/OrganizationInvitationStatus" } ], "description": "The current status for this organization invitation." }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this organization invitation.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "UTC timestamp for expires at on this organization invitation.", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "description": "UTC timestamp for sent at on this organization invitation.", "format": "date-time" }, "resentAt": { "type": [ "null", "string" ], "description": "UTC timestamp for resent at on this organization invitation.", "format": "date-time" }, "acceptedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for accepted at on this organization invitation.", "format": "date-time" }, "revokedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for revoked at on this organization invitation.", "format": "date-time" }, "sendFailureReason": { "type": [ "null", "string" ], "description": "The human-readable send failure reason explaining this organization invitation." }, "licenseBillingStatus": { "type": [ "null", "string" ], "description": "The billing status for the paid license created by this invitation." }, "licenseQuantity": { "type": [ "null", "integer" ], "description": "The quantity on the shared organization user license subscription item after this change.", "format": "int64" }, "licenseRenewalDate": { "type": [ "null", "string" ], "description": "The renewal date used for proration of this license.", "format": "date-time" }, "licenseActivatedAt": { "type": [ "null", "string" ], "description": "The date and time this invitation's paid license was created.", "format": "date-time" }, "licenseReleasedAt": { "type": [ "null", "string" ], "description": "The date and time this invitation's paid license was released.", "format": "date-time" } }, "description": "Describes organization invitation data used in Leadping API requests and responses." }, "OrganizationMemberRequest": { "type": "object", "properties": { "userId": { "type": [ "null", "string" ], "description": "User ID to add, update, or remove from the organization." }, "email": { "type": [ "null", "string" ], "description": "Email address for the person represented by this organization user request.", "format": "email" }, "role": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRole" } ], "description": "Organization role assigned to the user." } }, "description": "Defines the fields clients can send when working with organization user." }, "OrganizationMemberResponse": { "type": "object", "properties": { "organization": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Organization for this organization user." }, "user": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User for this organization user." }, "userEmail": { "type": [ "null", "string" ], "description": "User email for this organization user.", "format": "email" }, "role": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRole" } ], "description": "Role for this organization user." }, "createdByUserId": { "type": [ "null", "string" ], "description": "The created by user ID associated with this organization user." }, "removedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for removed at on this organization user.", "format": "date-time" }, "removedByUserId": { "type": [ "null", "string" ], "description": "The removed by user ID associated with this organization user." }, "lastUsedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for last used at on this organization user.", "format": "date-time" }, "licenseBillingStatus": { "type": [ "null", "string" ], "description": "The billing status for this user's organization license." }, "licenseQuantity": { "type": [ "null", "integer" ], "description": "The quantity on the shared organization user license item after this change.", "format": "int64" }, "licenseRenewalDate": { "type": [ "null", "string" ], "description": "The renewal date used for this user's license proration.", "format": "date-time" }, "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 organization user data returned by Leadping." }, "OrganizationMemberRole": { "enum": [ "Owner", "Admin", "Agent" ], "type": "string", "description": "Identifies an organization member's access level and permission scope within Leadping." }, "OrganizationMemberTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this organization user." }, "user": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related user." }, "userEmail": { "type": [ "null", "string" ], "description": "User email for this organization user.", "format": "email" }, "role": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRole" } ], "description": "Role for this organization user." }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this organization user.", "format": "date-time" }, "licenseBillingStatus": { "type": [ "null", "string" ], "description": "The billing status for this user's organization license." }, "licenseRenewalDate": { "type": [ "null", "string" ], "description": "The renewal date used for this user's license proration.", "format": "date-time" } }, "description": "Describes organization user data used in Leadping API requests and responses." }, "OrganizationRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Primary organization name." }, "secondaryName": { "type": [ "null", "string" ], "description": "Alternate organization name or DBA shown in Leadping." }, "phone": { "type": [ "null", "string" ], "description": "Phone details for the lead, user, or organization represented by this organization profile request." }, "address": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/StreetAddress" } ], "description": "Postal address for the organization, lead, or contact represented by this organization profile request." }, "website": { "type": [ "null", "string" ], "description": "Organization website URL used for compliance, brand review, and lead attribution." }, "vertical": { "type": [ "null", "string" ], "description": "Industry vertical used for lead routing, compliance review, and reporting." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this organization profile request to API users." }, "ein": { "type": [ "null", "string" ], "description": "Employer Identification Number used for organization and 10DLC verification." }, "isYoungerThan90": { "type": [ "null", "boolean" ], "description": "Whether the organization was formed less than 90 days ago." } }, "description": "Defines the fields clients can send when working with organization profile." }, "OrganizationResponse": { "type": "object", "properties": { "secondaryName": { "type": [ "null", "string" ], "description": "Alternate organization name or DBA shown in Leadping." }, "user": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary connected to this organization profile response." }, "accountBalance": { "type": "number", "description": "Current wallet balance available to the organization.", "format": "double" }, "billingPlan": { "enum": [ "Annual", "Monthly" ], "type": [ "null", "string" ], "description": "Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior." }, "subscriptionStatus": { "enum": [ "Pending", "Active", "Overdue", "Canceled" ], "type": [ "null", "string" ], "description": "Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states." }, "billingState": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/OrganizationBillingState" } ], "description": "Customer-safe billing state for this organization." }, "autoRefillEnabled": { "type": "boolean", "description": "Indicates whether automatic wallet refill is enabled for the organization." }, "autoRefillAmount": { "type": [ "null", "number" ], "description": "Wallet refill amount charged when automatic refill is triggered.", "format": "double" }, "autoRefillTrigger": { "type": [ "null", "number" ], "description": "Wallet balance threshold that triggers automatic refill.", "format": "double" }, "status": { "enum": [ "SettingUp", "SetupCompleted", "Active" ], "type": [ "null", "string" ], "description": "Describes an organization's account lifecycle and whether it can actively use Leadping services." }, "setupStatus": { "enum": [ "Personal", "Organization", "Details", "Compliance", "Phone", "Plan", "Billing", "Review", "Complete" ], "type": [ "null", "string" ], "description": "Describes a user's progress through required Leadping profile and account setup tasks." }, "enabled": { "type": "boolean", "description": "Indicates whether this organization profile response is active and available in the Leadping API." }, "phone": { "type": [ "null", "string" ], "description": "Phone details for the lead, user, or organization represented by this organization profile response." }, "website": { "type": [ "null", "string" ], "description": "Organization website URL used for compliance, brand review, and lead attribution." }, "address": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/StreetAddress" } ], "description": "Postal address for the organization, lead, or contact represented by this organization profile response." }, "billingName": { "type": [ "null", "string" ], "description": "Name used for invoices, receipts, and payment processor billing records." }, "billingAddress": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/StreetAddress" } ], "description": "Postal address used for invoices, receipts, and payment processor billing records." }, "billingTaxId": { "type": [ "null", "string" ], "description": "Tax identifier printed on billing documents. This may differ from the organization verification EIN." }, "vertical": { "type": [ "null", "string" ], "description": "Industry vertical used for lead routing, compliance review, and reporting." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this organization profile response to API users." }, "ein": { "type": [ "null", "string" ], "description": "Employer Identification Number used for organization and 10DLC verification." }, "einDocument": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNameValue" } ], "description": "Uploaded EIN document reference used for organization verification." }, "domain": { "type": [ "null", "string" ], "description": "Domain name connected to the organization website or activation workflow." }, "phones": { "type": [ "null", "array" ], "items": { "allOf": [ { "$ref": "#/components/schemas/IdNameValue" } ], "description": "Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata." }, "description": "Phone numbers assigned to this organization." }, "site": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Leadping website record connected to this organization." }, "setupStep": { "enum": [ "DomainFinding", "DomainOptionsFound", "SiteGenerating", "SiteGenerated", "BrandSubmitted", "BrandApproved", "CampaignSubmitted", "CampaignApproved", "CarrierReviewing", "TenDlcComplete", "Complete" ], "type": [ "null", "string" ], "description": "Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning." }, "activation": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/OrganizationActivationState" } ], "description": "Organization activation state covering site, billing, compliance, and telephony readiness." }, "compliancePolicy": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/OrganizationCompliancePolicy" } ], "description": "Compliance policy configuration for the organization." }, "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 organization profile data returned by Leadping." }, "OrganizationSwitchOption": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this organization switch option." }, "name": { "type": "string", "description": "The human-readable name shown for this organization switch option." }, "role": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMemberRole" } ], "description": "Role for this organization switch option." }, "isCurrent": { "type": "boolean", "description": "Whether this organization switch option is current." }, "lastUsedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for last used at on this organization switch option.", "format": "date-time" }, "organizationStatus": { "enum": [ "SettingUp", "SetupCompleted", "Active" ], "type": [ "null", "string" ], "description": "Describes an organization's account lifecycle and whether it can actively use Leadping services." }, "activationStatus": { "enum": [ "DraftOnboarding", "PaymentMethodPending", "PaymentMethodConfirmed", "SubscriptionPending", "SubscriptionReceived", "SubscriptionActive", "LaunchReviewPending", "TelephonyProvisioningPending", "TelephonyPartiallyProvisioned", "TelephonyReady", "AwaitingReview", "DomainSelection", "WebsiteSetup", "ComplianceRegistration", "ReadyForApproval", "Active", "Failed", "Blocked", "BlockedRequiresOperatorAction", "ManuallyBypassed" ], "type": [ "null", "string" ], "description": "Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness." }, "tenDlcStatus": { "enum": [ "NotStarted", "DraftGenerated", "DraftIncomplete", "ReadyToSubmit", "Submitted", "PendingTelnyxReview", "Approved", "Rejected", "NeedsChanges", "ResubmissionReady", "Failed" ], "type": [ "null", "string" ], "description": "Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission." }, "needsAdminReview": { "type": "boolean", "description": "Whether needs admin review applies to this organization switch option." }, "activationSummary": { "type": [ "null", "string" ], "description": "Activation summary for this organization switch option." }, "hasPaymentMethod": { "type": "boolean", "description": "Whether the organization has a default billing payment method." }, "readyForCustomerTraffic": { "type": "boolean", "description": "Whether ready for customer traffic applies to this organization switch option." } }, "description": "Describes organization switch option data used in Leadping API requests and responses." }, "OrganizationSwitchRequest": { "required": [ "organizationId" ], "type": "object", "properties": { "organizationId": { "type": "string", "description": "Organization ID to switch into for the current Leadping session." } }, "description": "Defines the fields clients can send when working with organization switch." }, "OutboundCapacityOverview": { "type": "object", "properties": { "smsCapacityRemainingToday": { "type": "integer", "description": "SMS capacity remaining today for the applicable messaging or voice capacity window.", "format": "int32" }, "voiceCapacityRemainingToday": { "type": "integer", "description": "Voice capacity remaining today for the applicable messaging or voice capacity window.", "format": "int32" }, "healthyPhoneNumbers": { "type": "integer", "description": "Number of healthy phone numbers represented by this Leadping outbound capacity overview.", "format": "int32" }, "limitedPhoneNumbers": { "type": "integer", "description": "Number of limited phone numbers represented by this Leadping outbound capacity overview.", "format": "int32" }, "coolingPhoneNumbers": { "type": "integer", "description": "Number of cooling phone numbers represented by this Leadping outbound capacity overview.", "format": "int32" }, "rampingPhoneNumbers": { "type": "integer", "description": "Number of phone numbers whose SMS or calling capacity is still ramping up.", "format": "int32" }, "scheduledCount": { "type": "integer", "description": "Total number of scheduled records represented by this Leadping outbound capacity overview.", "format": "int32" }, "blockedCount": { "type": "integer", "description": "Total number of blocked records represented by this Leadping outbound capacity overview.", "format": "int32" }, "phoneNumbers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/OutboundPhoneNumberCapacity" } ], "description": "Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery." }, "description": "Collection of phone numbers included with this Leadping outbound capacity overview." }, "recentDecisions": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/OutboundQueueItem" } ], "description": "Describes a queued or recently evaluated outbound delivery request and the pacing decision that controls when it may be sent." }, "description": "Collection of recent decisions included with this Leadping outbound capacity overview." } }, "description": "Summarizes organization-wide SMS and voice sending capacity, phone-number health, and recent outbound pacing decisions." }, "OutboundDeliveryChannel": { "enum": [ "sms", "voice", "email", "webhook", "internal_notification" ], "type": "string", "description": "Defines outbound delivery channels protected by delivery control." }, "OutboundDeliverySource": { "enum": [ "manual", "automation", "campaign", "import", "api", "system_notification", "warmup", "retry" ], "type": "string", "description": "Defines the source that requested outbound delivery." }, "OutboundDeliveryStatus": { "enum": [ "pending", "scheduled", "reserved", "sending", "sent", "failed", "skipped", "blocked", "cancelled" ], "type": "string", "description": "Defines durable outbound delivery request statuses." }, "OutboundPhoneNumberCapacity": { "type": "object", "properties": { "capacityAvailable": { "type": "boolean", "description": "Indicates whether Leadping successfully calculated capacity for this phone number." }, "phoneNumberId": { "type": [ "null", "string" ], "description": "Unique identifier of the phone number associated with this Leadping outbound phone number capacity." }, "phoneNumber": { "type": [ "null", "string" ], "description": "Phone number associated with this Leadping outbound phone number capacity." }, "healthStatus": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberOutboundHealthStatus" } ], "description": "Current health status for this Leadping outbound phone number capacity." }, "healthReason": { "type": [ "null", "string" ], "description": "Human-readable reason for the current phone-number health state." }, "smsApproved": { "type": "boolean", "description": "Indicates whether this phone number has an approved 10DLC messaging campaign assignment." }, "smsRamping": { "type": "boolean", "description": "Indicates whether SMS limits for this phone number are still ramping up." }, "smsRemainingThisMinute": { "type": "integer", "description": "SMS remaining in the current rolling minute.", "format": "int32" }, "smsUsedThisMinute": { "type": "integer", "description": "SMS used in the current rolling minute.", "format": "int32" }, "smsLimitThisMinute": { "type": "integer", "description": "SMS limit for one rolling minute.", "format": "int32" }, "smsMinutelyResetsAt": { "type": [ "null", "string" ], "description": "The next time SMS capacity becomes available in the rolling minute window.", "format": "date-time" }, "smsRemainingToday": { "type": "integer", "description": "SMS remaining today for the applicable messaging or voice capacity window.", "format": "int32" }, "smsUsedToday": { "type": "integer", "description": "SMS used today for the applicable messaging or voice capacity window.", "format": "int32" }, "smsLimitToday": { "type": "integer", "description": "Number of SMS limit today represented by this Leadping outbound phone number capacity.", "format": "int32" }, "smsDailyResetsAt": { "type": [ "null", "string" ], "description": "Next midnight Eastern time, when SMS daily capacity resets.", "format": "date-time" }, "smsRemainingThisHour": { "type": "integer", "description": "SMS remaining this hour for the applicable messaging or voice capacity window.", "format": "int32" }, "smsUsedThisHour": { "type": "integer", "description": "SMS used this hour for the applicable messaging or voice capacity window.", "format": "int32" }, "smsLimitThisHour": { "type": "integer", "description": "Number of SMS limit this hour represented by this Leadping outbound phone number capacity.", "format": "int32" }, "smsHourlyResetsAt": { "type": [ "null", "string" ], "description": "Start of the next Eastern time hour, when SMS hourly capacity resets.", "format": "date-time" }, "voiceRamping": { "type": "boolean", "description": "Indicates whether call limits for this phone number are still ramping up." }, "voiceRemainingThisMinute": { "type": "integer", "description": "Voice remaining in the current rolling minute.", "format": "int32" }, "voiceUsedThisMinute": { "type": "integer", "description": "Voice used in the current rolling minute.", "format": "int32" }, "voiceLimitThisMinute": { "type": "integer", "description": "Voice limit for one rolling minute.", "format": "int32" }, "voiceMinutelyResetsAt": { "type": [ "null", "string" ], "description": "The next time voice capacity becomes available in the rolling minute window.", "format": "date-time" }, "voiceRemainingToday": { "type": "integer", "description": "Voice remaining today for the applicable messaging or voice capacity window.", "format": "int32" }, "voiceUsedToday": { "type": "integer", "description": "Voice used today for the applicable messaging or voice capacity window.", "format": "int32" }, "voiceLimitToday": { "type": "integer", "description": "Voice limit today associated with this Leadping outbound phone number capacity.", "format": "int32" }, "voiceDailyResetsAt": { "type": [ "null", "string" ], "description": "Next midnight Eastern time, when voice daily capacity resets.", "format": "date-time" }, "voiceRemainingThisHour": { "type": "integer", "description": "Voice remaining this hour for the applicable messaging or voice capacity window.", "format": "int32" }, "voiceUsedThisHour": { "type": "integer", "description": "Voice used this hour for the applicable messaging or voice capacity window.", "format": "int32" }, "voiceLimitThisHour": { "type": "integer", "description": "Voice limit this hour associated with this Leadping outbound phone number capacity.", "format": "int32" }, "voiceHourlyResetsAt": { "type": [ "null", "string" ], "description": "Start of the next Eastern time hour, when voice hourly capacity resets.", "format": "date-time" } }, "description": "Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery." }, "OutboundQueueItem": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Unique Leadping identifier for the outbound queue item." }, "channel": { "allOf": [ { "$ref": "#/components/schemas/OutboundDeliveryChannel" } ], "description": "Channel classification for this Leadping outbound queue item." }, "source": { "allOf": [ { "$ref": "#/components/schemas/OutboundDeliverySource" } ], "description": "Source classification for this Leadping outbound queue item." }, "status": { "allOf": [ { "$ref": "#/components/schemas/OutboundDeliveryStatus" } ], "description": "Current status for this Leadping outbound queue item." }, "reasonCode": { "enum": [ "allowed", "no_eligible_phone_number", "ten_dlc_not_approved", "phone_number_daily_limit_reached", "phone_number_hourly_limit_reached", "phone_number_minute_limit_reached", "lead_daily_limit_reached", "lead_hourly_limit_reached", "lead_recently_contacted", "lead_archived", "quiet_hours", "wallet_insufficient", "contact_opted_out", "imported_lead_requires_consent", "automation_bulk_import_disabled", "number_cooling_down", "number_health_blocked", "provider_failure_backoff", "campaign_daily_limit_reached", "reservation_unavailable" ], "type": [ "null", "string" ], "description": "Structured reason codes for outbound pacing and blocking decisions." }, "reason": { "type": [ "null", "string" ], "description": "Human-readable explanation for the current outbound queue item outcome." }, "scheduledSendAt": { "type": [ "null", "string" ], "description": "Date and time when this Leadping outbound queue item was scheduled send.", "format": "date-time" }, "phoneNumber": { "type": [ "null", "string" ], "description": "Phone number associated with this Leadping outbound queue item." } }, "description": "Describes a queued or recently evaluated outbound delivery request and the pacing decision that controls when it may be sent." }, "OutgoingNumberManualOverrideRequest": { "required": [ "fromPhoneNumberId", "selection" ], "type": "object", "properties": { "fromPhoneNumberId": { "type": "string", "description": "Sender phone number ID used for this outbound SMS or call." }, "selection": { "allOf": [ { "$ref": "#/components/schemas/OutgoingNumberSelectionRequest" } ], "description": "Selected outgoing number and selection rationale returned by Leadping." } }, "description": "Defines the fields clients can send when working with outgoing number manual override." }, "OutgoingNumberSelectionReason": { "enum": [ "StickyConversation", "LeadAssigned", "CampaignOrSource", "Preferred", "LocalArea", "HealthyPool", "FallbackDefault", "ManualOverride" ], "type": "string", "description": "Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number." }, "OutgoingNumberSelectionRequest": { "type": "object", "properties": { "conversationId": { "type": [ "null", "string" ], "description": "Conversation ID that links this outgoing number selection request to the Leadping inbox thread." }, "leadId": { "type": [ "null", "string" ], "description": "Lead ID used to choose the best outgoing sender number." }, "recipientPhoneNumber": { "type": [ "null", "string" ], "description": "Recipient phone number that receives the outbound message or call." }, "channel": { "enum": [ "sms", "call" ], "type": [ "null", "string" ], "description": "Identifies whether an outgoing phone number is eligible for voice, SMS, MMS, or another communication channel." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this outgoing number selection request." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID used to choose the best outgoing sender number." }, "teamId": { "type": [ "null", "string" ], "description": "Organization ID used to choose the best outgoing sender number." } }, "description": "Defines the fields clients can send when working with outgoing number selection." }, "OutgoingNumberSelectionResponse": { "type": "object", "properties": { "canSend": { "type": "boolean", "description": "Indicates whether Leadping can send outbound messages using this outgoing number selection response." }, "setupMessage": { "type": [ "null", "string" ], "description": "Human-readable setup guidance shown for this outgoing number selection response." }, "phoneNumberId": { "type": [ "null", "string" ], "description": "Leadping phone number ID connected to this outgoing number selection response." }, "number": { "type": [ "null", "string" ], "description": "E.164 phone number exposed by this outgoing number selection response." }, "displayNumber": { "type": [ "null", "string" ], "description": "Human-readable phone number shown in Leadping UI and API responses." }, "healthStatus": { "enum": [ "Not Evaluated", "Evaluating", "Healthy", "Needs Attention", "Blocked" ], "type": [ "null", "string" ], "description": "Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic." }, "healthLabel": { "type": [ "null", "string" ], "description": "Short label describing the health state for display in dashboards." }, "healthWarning": { "type": [ "null", "string" ], "description": "Warning text that explains a potential health or readiness issue." }, "selectionReason": { "enum": [ "StickyConversation", "LeadAssigned", "CampaignOrSource", "Preferred", "LocalArea", "HealthyPool", "FallbackDefault", "ManualOverride" ], "type": [ "null", "string" ], "description": "Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number." }, "reasonLabel": { "type": [ "null", "string" ], "description": "Human-readable label for the reason code on this outgoing number selection response." }, "wasManuallyOverridden": { "type": "boolean", "description": "Indicates whether a user manually overrode Leadping's automatic number selection for this outgoing number selection response." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this outgoing number selection response." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID considered when Leadping selected the outgoing phone number." }, "eligibleNumbers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/EligibleOutgoingNumberResponse" } ], "description": "Describes a Leadping phone number that is eligible to send an outbound message or place a call." }, "description": "Phone numbers that are eligible to send the requested outbound message or call." } }, "description": "Describes outgoing number selection data returned by Leadping." }, "PagedResultOfAutomationTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AutomationTableRow" } ], "description": "Summarizes automation data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfCallEventTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CallEventTableRow" } ], "description": "Summarizes call event data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfConversationResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ConversationResponse" } ], "description": "Describes conversation data returned by Leadping." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfEventTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/EventTableRow" } ], "description": "Summarizes event timeline data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfLeadStatusChangeResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LeadStatusChangeResponse" } ], "description": "Describes an auditable lead status transition, including the previous and new status, source, actor, and effective time." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfLeadTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LeadTableRow" } ], "description": "Summarizes lead data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfNotificationTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/NotificationTableRow" } ], "description": "Describes notification data returned by Leadping." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfPhoneNumberTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberTableRow" } ], "description": "Summarizes phone number data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfSmsEventTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/SmsEventTableRow" } ], "description": "Summarizes SMS event data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfSourceTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/SourceTableRow" } ], "description": "Summarizes lead source data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfSuppressionEntryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryResponse" } ], "description": "Describes a recipient suppression that prevents outreach through one or more communication channels." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfTransactionTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/TransactionTableRow" } ], "description": "Summarizes billing transaction data in paginated and searchable results." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "PagedResultOfUsageLedgerTableRow": { "type": "object", "properties": { "items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/UsageLedgerTableRow" } ], "description": "Describes usage ledger data used in Leadping API requests and responses." }, "description": "Items included in the current page, in the order determined by the query." }, "pageSize": { "type": "integer", "description": "Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.", "format": "int32" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of records matching the query across all pages, or null when counting was not requested or computed.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it." } }, "description": "Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata." }, "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." }, "PhoneCallResponse": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/PhoneCallStatus" } ], "description": "Current lifecycle status for this phone call in the Leadping API." }, "statusReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining the current status of this phone call." }, "direction": { "type": [ "null", "string" ], "description": "Communication direction for this phone call, such as inbound or outbound." }, "conversationId": { "type": [ "null", "string" ], "description": "Conversation ID that links this phone call to the Leadping inbox thread." }, "leadId": { "type": [ "null", "string" ], "description": "Lead ID associated with the call conversation or outreach attempt." }, "phoneNumber": { "type": "string", "description": "Phone number used by this phone call for calls, SMS, lookup, or routing." }, "toPhoneNumber": { "type": [ "null", "string" ], "description": "Recipient phone number used for this communication." }, "fromPhoneNumberId": { "type": [ "null", "string" ], "description": "Sender phone number ID used for this outbound SMS or call." }, "fromPhoneNumber": { "type": [ "null", "string" ], "description": "Sender phone number used for this communication." }, "callerId": { "type": [ "null", "string" ], "description": "Caller ID phone number presented during the outbound call." }, "selectionReason": { "enum": [ "StickyConversation", "LeadAssigned", "CampaignOrSource", "Preferred", "LocalArea", "HealthyPool", "FallbackDefault", "ManualOverride" ], "type": [ "null", "string" ], "description": "Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number." }, "wasManuallyOverridden": { "type": "boolean", "description": "Indicates whether a user manually overrode Leadping's automatic number selection for this phone call." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this phone call." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID used for attribution and routing on this call." }, "endedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the call ended.", "format": "date-time" }, "queuedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping queued this phone call for processing.", "format": "date-time" }, "ringingAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the call started ringing.", "format": "date-time" }, "answeredAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the call was answered.", "format": "date-time" }, "durationSeconds": { "type": [ "null", "integer" ], "description": "Call duration in seconds.", "format": "int32" }, "billingStatus": { "type": [ "null", "string" ], "description": "Billing state for this communication, charge, or transaction." }, "billableAmount": { "type": [ "null", "number" ], "description": "Monetary amount billed for this Leadping communication or transaction.", "format": "double" }, "recordingUrl": { "type": [ "null", "string" ], "description": "URL for the call recording, when the provider makes one available.", "format": "uri" }, "consoleEntries": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CommunicationConsoleEntry" } ], "description": "Describes one durable diagnostic entry from the processing of a communication." }, "description": "Ordered diagnostic entries recorded while Leadping processed this call." }, "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 a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details." }, "PhoneCallStatus": { "enum": [ "scheduled", "queued", "initiated", "ringing", "in_progress", "active", "completed", "ended", "busy", "no_answer", "failed", "canceled", "missed", "transferred", "voicemail", "blocked_billing", "blocked_phone_number_status", "blocked_configuration", "blocked_permission", "configuration_required" ], "type": "string", "description": "Describes the durable business outcome of a Leadping phone call after provider status normalization." }, "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." }, "PhoneIdentityLookupActionStatus": { "enum": [ "succeeded", "failed" ], "type": "string", "description": "Identifies the outcome of a phone identity lookup action." }, "PhoneIdentityLookupActionType": { "enum": [ "validation", "enrichment", "unwanted-number-check" ], "type": "string", "description": "Identifies the kind of lookup action performed for a phone identity." }, "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." }, "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." }, "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." }, "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." }, "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." }, "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." }, "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." }, "PhoneNumberAvailabilityRequest": { "required": [ "phoneNumber" ], "type": "object", "properties": { "phoneNumber": { "type": "string", "description": "Phone number to check for availability, formatted for provider lookup." } }, "description": "Defines the phone number and capability requirements Leadping should verify before purchase or assignment." }, "PhoneNumberAvailabilityResponse": { "type": "object", "properties": { "phoneNumber": { "type": "string", "description": "Phone number used by this phone number availability result for calls, SMS, lookup, or routing." }, "isAvailable": { "type": "boolean", "description": "Indicates whether this phone number is available for purchase or assignment." }, "price": { "type": [ "null", "number" ], "description": "Lead price or transaction price supplied to the Leadping API.", "format": "double" }, "currency": { "type": [ "null", "string" ], "description": "ISO currency code used for the monetary amounts in this phone number availability result." }, "location": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/PhoneNumberLocation" } ], "description": "Geographic location metadata for the phone number, lead, or lookup result." } }, "description": "Reports whether a phone number is available for purchase or assignment and explains any blocking condition." }, "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." }, "PhoneNumberMessagingEventResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this phone number messaging event." }, "createdAt": { "type": "string", "description": "UTC timestamp when this phone number messaging event was created.", "format": "date-time" }, "label": { "type": "string", "description": "Short display label for this phone number messaging event, formatted for charts, filters, or list views." }, "eventType": { "type": "string", "description": "Event type used to classify this timeline, SMS, call, or automation event." }, "direction": { "type": "string", "description": "Communication direction for this phone number messaging event, such as inbound or outbound." }, "fromPhoneNumber": { "type": "string", "description": "Sender phone number used for this communication." }, "toPhoneNumber": { "type": "string", "description": "Recipient phone number used for this communication." }, "textPreview": { "type": "string", "description": "Short preview of the SMS or conversation text for this phone number messaging event." }, "isOptOut": { "type": "boolean", "description": "Indicates whether the recipient has opted out of further SMS communication." } }, "description": "Describes a messaging event used to calculate delivery, failure, and opt-out metrics for a phone number." }, "PhoneNumberOptOutMetricsResponse": { "type": "object", "properties": { "windowDays": { "type": "integer", "description": "Number of days included in the metrics reporting window.", "format": "int32" }, "windowStartedAt": { "type": "string", "description": "UTC timestamp when the metrics reporting window starts.", "format": "date-time" }, "distinctContactedCount": { "type": "integer", "description": "Number of distinct recipients contacted during this metrics window.", "format": "int32" }, "optOutCount": { "type": "integer", "description": "Number of recipients who opted out during this metrics window.", "format": "int32" }, "optOutRatePercent": { "type": "number", "description": "Percentage of contacted recipients who opted out during this metrics window.", "format": "double" } }, "description": "Describes phone number opt-out metrics data returned by Leadping." }, "PhoneNumberOutboundHealthStatus": { "enum": [ "unknown", "new", "healthy", "warmup", "limited", "cooling_down", "suspended", "disabled" ], "type": "string", "description": "Defines phone-number outbound health states used by pacing." }, "PhoneNumberReadiness": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Indicates whether phone number warmup is enabled in Leadping." }, "state": { "enum": [ "Not Started", "In Progress", "Paused", "Blocked", "Ready" ], "type": [ "null", "string" ], "description": "Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping." }, "healthStatus": { "enum": [ "Not Evaluated", "Evaluating", "Healthy", "Needs Attention", "Blocked" ], "type": [ "null", "string" ], "description": "Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic." }, "healthScore": { "type": "integer", "description": "Current warmup health score used to assess phone number warmup.", "format": "int32" }, "progressPercent": { "type": "integer", "description": "Warmup completion percentage, from 0 through 100.", "format": "int32" }, "callStage": { "enum": [ "Stage 0", "Stage 1", "Stage 2", "Stage 3", "Stage 4" ], "type": [ "null", "string" ], "description": "Identifies the current traffic-ramp stage of controlled voice warmup for a Leadping-managed phone number." } }, "description": "Messaging and calling warmup for a Leadping phone number." }, "PhoneNumberRequest": { "required": [ "number" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Human-readable label for the phone number." }, "number": { "type": "string", "description": "E.164 phone number exposed by this phone number update request." } }, "description": "Defines the fields clients can send when working with phone number update." }, "PhoneNumberResponse": { "type": "object", "properties": { "number": { "type": "string", "description": "E.164 phone number exposed by this phone number." }, "phoneIdentityId": { "type": [ "null", "string" ], "description": "Identifier of the canonical phone identity for this number." }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Organization summary connected to this phone number." }, "leadpingOwned": { "type": "boolean", "description": "Indicates whether Leadping provisions and manages this phone number." }, "routing": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberRoutingMetadata" } ], "description": "Routing metadata that connects this phone number to teams, campaigns, and sources." }, "enabled": { "type": "boolean", "description": "Indicates whether this phone number is active and available in the Leadping API." }, "warmup": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberReadiness" } ], "description": "SMS and call warmup for this phone number." }, "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 a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details." }, "PhoneNumberRoutingMetadata": { "type": "object", "properties": { "smsEnabled": { "type": "boolean", "description": "Indicates whether the phone number can be used for SMS messaging." }, "voiceEnabled": { "type": "boolean", "description": "Indicates whether the phone number can be used for voice calls." }, "teamId": { "type": [ "null", "string" ], "description": "Organization ID used to route calls and messages for this phone number." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID assigned to this phone number for attribution and routing." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this phone number routing metadata." }, "tenDlcApplicationId": { "type": [ "null", "string" ], "description": "Leadping 10DLC application entity associated with this phone number." } }, "description": "Public Leadping API schema for phone number routing metadata data." }, "PhoneNumberSearchRequest": { "type": "object", "properties": { "phoneNumber": { "type": [ "null", "string" ], "description": "Phone number used by this phone number search request for calls, SMS, lookup, or routing." }, "location": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/PhoneNumberLocation" } ], "description": "Geographic location metadata for the phone number, lead, or lookup result." } }, "description": "Defines the fields clients can send when working with phone number search." }, "PhoneNumberSearchResponse": { "type": "object", "properties": { "numbers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberSearchResult" } ], "description": "Result schema for the Leadping API phone number search result returned by lookup and validation endpoints." }, "description": "Phone numbers returned or evaluated by this phone number search response." } }, "description": "Describes phone number search data returned by Leadping." }, "PhoneNumberSearchResult": { "type": "object", "properties": { "number": { "type": "string", "description": "E.164 phone number exposed by this phone number search result." }, "location": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/PhoneNumberLocation" } ], "description": "Geographic location metadata for the phone number, lead, or lookup result." } }, "description": "Result schema for the Leadping API phone number search result returned by lookup and validation endpoints." }, "PhoneNumberStatusResponse": { "type": "object", "properties": { "number": { "type": "string", "description": "E.164 phone number exposed by this phone number warmup status." }, "messagesPossible": { "type": "integer", "description": "Indicates whether this phone number can currently send SMS messages.", "format": "int32" }, "callsPossible": { "type": "integer", "description": "Indicates whether this phone number can currently place outbound calls.", "format": "int32" }, "smsWarmup": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/SmsReadinessStatusResponse" } ], "description": "SMS warmup status for this phone number." }, "outboundCapacity": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/OutboundPhoneNumberCapacity" } ], "description": "Current outbound SMS and voice capacity for this phone number." }, "optOutMetrics": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberOptOutMetricsResponse" } ], "description": "Recent SMS opt-out metrics used to evaluate sender health and compliance risk." }, "trafficMetrics": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberTrafficMetricsResponse" } ], "description": "Phone number traffic metrics for recent SMS and call activity." }, "recentEvents": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberMessagingEventResponse" } ], "description": "Describes a messaging event used to calculate delivery, failure, and opt-out metrics for a phone number." }, "description": "Recent workflow events returned for timeline and troubleshooting." } }, "description": "Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic." }, "PhoneNumberTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this phone number table row." }, "name": { "type": "string", "description": "Optional display label for this phone number table row in the Leadping API." }, "number": { "type": "string", "description": "E.164 phone number exposed by this phone number table row." }, "type": { "type": "string", "description": "Type classification used to route and interpret this phone number table row in the Leadping API." }, "organization": { "type": "string", "description": "Organization summary connected to this phone number table row." }, "organizationId": { "type": [ "null", "string" ], "description": "Unique Leadping organization identifier connected to this phone number table row." }, "enabled": { "type": "boolean", "description": "Indicates whether this phone number table row is active and available in the Leadping API." }, "warmup": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberReadiness" } ], "description": "Warmup state for this phone number." }, "ownership": { "type": "string", "description": "Ownership classification for this phone number, such as Leadping-owned or customer-owned." }, "routingSummary": { "type": "string", "description": "Human-readable routing summary for this phone number." }, "smsReady": { "type": "boolean", "description": "Indicates whether SMS messaging is ready for this organization or phone number." }, "voiceReady": { "type": "boolean", "description": "Indicates whether voice calling is ready for this organization or phone number." }, "tenDlcCampaignStatus": { "type": [ "null", "string" ], "description": "10DLC campaign status associated with this sender or SMS event." } }, "description": "Summarizes phone number data in paginated and searchable results." }, "PhoneNumberTrafficMetricsResponse": { "type": "object", "properties": { "windowDays": { "type": "integer", "description": "Number of days included in the metrics reporting window.", "format": "int32" }, "windowStartedAt": { "type": "string", "description": "UTC timestamp when the metrics reporting window starts.", "format": "date-time" }, "smsSentCount": { "type": "integer", "description": "Number of SMS messages sent during this metrics window.", "format": "int32" }, "smsFailedCount": { "type": "integer", "description": "Number of SMS messages that failed during this metrics window.", "format": "int32" }, "mmsSentCount": { "type": "integer", "description": "Number of MMS messages sent during this metrics window.", "format": "int32" }, "mmsFailedCount": { "type": "integer", "description": "Number of MMS messages that failed during this metrics window.", "format": "int32" }, "callPlacedCount": { "type": "integer", "description": "Number of outbound calls placed during this metrics window.", "format": "int32" }, "callFailedCount": { "type": "integer", "description": "Number of outbound calls that failed during this metrics window.", "format": "int32" }, "callConnectedCount": { "type": "integer", "description": "Number of outbound calls that connected during this metrics window.", "format": "int32" }, "callShortCount": { "type": "integer", "description": "Number of connected outbound calls shorter than 30 seconds during this metrics window.", "format": "int32" }, "callInvalidNumberCount": { "type": "integer", "description": "Number of outbound calls that failed because the destination number was invalid during this metrics window.", "format": "int32" }, "trend": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberTrafficTrendPoint" } ], "description": "Time-series data point schema for Leadping API phone number traffic trend bucket charts and metrics." }, "description": "Time-series buckets that show how the metric changes across the reporting window." } }, "description": "Describes phone number traffic metrics data returned by Leadping." }, "PhoneNumberTrafficTrendPoint": { "type": "object", "properties": { "startAt": { "type": "string", "description": "UTC timestamp when this reporting bucket starts.", "format": "date-time" }, "endAt": { "type": "string", "description": "UTC timestamp when this reporting bucket ends.", "format": "date-time" }, "label": { "type": "string", "description": "Short display label for this phone number traffic trend bucket, formatted for charts, filters, or list views." }, "smsSentCount": { "type": "integer", "description": "Number of SMS messages sent during this metrics window.", "format": "int32" }, "smsFailedCount": { "type": "integer", "description": "Number of SMS messages that failed during this metrics window.", "format": "int32" }, "mmsSentCount": { "type": "integer", "description": "Number of MMS messages sent during this metrics window.", "format": "int32" }, "mmsFailedCount": { "type": "integer", "description": "Number of MMS messages that failed during this metrics window.", "format": "int32" }, "callPlacedCount": { "type": "integer", "description": "Number of outbound calls placed during this metrics window.", "format": "int32" }, "callFailedCount": { "type": "integer", "description": "Number of outbound calls that failed during this metrics window.", "format": "int32" } }, "description": "Time-series data point schema for Leadping API phone number traffic trend bucket charts and metrics." }, "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." }, "PushInstallationRequest": { "type": "object", "properties": { "installationId": { "type": "string", "description": "The stable installation identifier assigned by the mobile client." }, "platform": { "type": "string", "description": "The Azure Notification Hubs platform name, such as apns or fcmv1." }, "pushChannel": { "type": "string", "description": "The provider-issued push token or channel used to deliver notifications." }, "appIdentifier": { "type": "string", "description": "The application bundle identifier or package name." }, "appName": { "type": [ "null", "string" ], "description": "The human-readable application name reported by the client." }, "appVersion": { "type": [ "null", "string" ], "description": "The semantic application version reported by the client." }, "appBuild": { "type": [ "null", "string" ], "description": "The application build number reported by the client." }, "devicePlatform": { "type": [ "null", "string" ], "description": "The mobile operating-system platform reported by the device." }, "deviceVersion": { "type": [ "null", "string" ], "description": "The mobile operating-system version reported by the device." }, "deviceModel": { "type": [ "null", "string" ], "description": "The device model reported by the client." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional client metadata stored with the push installation." } }, "description": "Describes a mobile push installation. Identity and Azure tags are derived by the API." }, "RangeFilter": { "type": "object", "properties": { "greaterThan": { "description": "Exclusive lower bound; matching field values must be greater than this value." }, "greaterThanOrEqual": { "description": "Inclusive lower bound; matching field values must be greater than or equal to this value." }, "lessThan": { "description": "Exclusive upper bound; matching field values must be less than this value." }, "lessThanOrEqual": { "description": "Inclusive upper bound; matching field values must be less than or equal to this value." }, "field": { "type": "string", "description": "Serializable field name to evaluate; supported names are determined by the queried resource." } }, "description": "Selects records by applying inclusive or exclusive lower and upper bounds to a named comparable field." }, "RequestDataOptions": { "type": "object", "properties": { "pageSize": { "type": "integer", "description": "Maximum number of items requested for one page; the server may enforce a lower maximum or apply a default.", "format": "int32" }, "continuationToken": { "type": [ "null", "string" ], "description": "Opaque cursor returned by the previous paged response; omit it when requesting the first page and do not parse or modify it." }, "orderBy": { "type": [ "null", "array" ], "items": { "allOf": [ { "$ref": "#/components/schemas/OrderByOption" } ], "description": "Defines one field and direction used to order an API query result set." }, "description": "Sort instructions applied in priority order, with the first entry acting as the primary sort." }, "includeCount": { "type": [ "null", "boolean" ], "description": "Whether the response should include the total number of matching records; counting may increase query cost or latency." }, "search": { "type": [ "null", "string" ], "description": "Free-text search term applied to the configured SearchFields." }, "searchFields": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Serializable string field names searched for Search; supported names are determined by the queried resource." }, "filters": { "type": [ "null", "array" ], "items": { "allOf": [ { "$ref": "#/components/schemas/ExactMatchFilter" } ], "description": "Selects records whose named field equals a supplied scalar value." }, "description": "Exact-match conditions that require each named field to equal its supplied value." }, "rangeFilters": { "type": [ "null", "array" ], "items": { "allOf": [ { "$ref": "#/components/schemas/RangeFilter" } ], "description": "Selects records by applying inclusive or exclusive lower and upper bounds to a named comparable field." }, "description": "Range conditions that constrain comparable fields with inclusive or exclusive lower and upper bounds." } }, "description": "Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query." }, "SendSmsRequest": { "required": [ "conversationId", "text" ], "type": "object", "properties": { "smsEventId": { "type": [ "null", "string" ], "description": "Existing SMS event ID to reuse or update when retrying a send request." }, "scheduledFor": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping should send the SMS message.", "format": "date-time" }, "conversationId": { "type": "string", "description": "Conversation ID that links this SMS send request to the Leadping inbox thread." }, "fromPhoneNumberId": { "type": [ "null", "string" ], "description": "Sender phone number ID used for this outbound SMS or call." }, "wasManuallyOverridden": { "type": "boolean", "description": "Indicates whether a user manually overrode Leadping's automatic number selection for this SMS send request." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this SMS send request." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID used for attribution and sender selection." }, "text": { "type": "string", "description": "Body text for the SMS message or communication represented by this SMS send request." }, "mediaUrls": { "type": "array", "items": { "type": "string" }, "description": "Public HTTPS media URLs to attach. Supplying at least one URL sends the message as MMS." }, "outboundIdempotencyKey": { "type": [ "null", "string" ], "description": "Idempotency key used to prevent duplicate outbound delivery." } }, "description": "Defines the fields clients can send when working with SMS send.", "example": { "conversationId": "conversation-123", "text": "Thanks for your interest. When is a good time to talk?", "mediaUrls": [ ], "outboundIdempotencyKey": "sms-example-001" } }, "SmsEventTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this SMS event table row." }, "conversationId": { "type": [ "null", "string" ], "description": "Conversation ID that links this SMS event table row to the Leadping inbox thread." }, "lead": { "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related lead." }, "fromPhoneNumberId": { "type": "string", "description": "Sender phone number ID used for this outbound SMS or call." }, "outboundPhoneNumberId": { "type": "string", "description": "Phone number ID selected for outbound delivery." }, "fromPhoneNumber": { "type": "string", "description": "Sender phone number used for this communication." }, "toPhoneNumber": { "type": "string", "description": "Recipient phone number used for this communication." }, "text": { "type": "string", "description": "Body text for the SMS message or communication represented by this SMS event table row." }, "media": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/MessageMediaAttachment" } ], "description": "Media attached to an SMS/MMS conversation event." }, "description": "Media attached to this SMS/MMS event." }, "status": { "enum": [ "draft", "scheduled", "queued", "sending", "sent", "received", "delivered", "failed", "undeliverable", "opted_out", "blocked_compliance", "blocked_billing", "blocked_missing_campaign", "canceled" ], "type": [ "null", "string" ], "description": "Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure." }, "statusReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining the current status of this SMS event table row." }, "direction": { "type": "string", "description": "Communication direction for this SMS event table row, such as inbound or outbound." }, "createdAt": { "type": "string", "description": "UTC timestamp when this SMS event table row was created.", "format": "date-time" }, "queuedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping queued this SMS event table row for processing.", "format": "date-time" }, "scheduledFor": { "type": [ "null", "string" ], "description": "UTC timestamp when this SMS event is scheduled to send.", "format": "date-time" }, "scheduledReason": { "type": [ "null", "string" ], "description": "Reason Leadping scheduled this delivery for a later time." }, "sendingStartedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping began sending this message.", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping sent this message to the provider.", "format": "date-time" }, "deliveredAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider confirmed delivery.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when processing failed for this SMS event table row.", "format": "date-time" }, "undeliverableAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider marked the message undeliverable.", "format": "date-time" }, "receivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping received this inbound event or message.", "format": "date-time" }, "blockedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping blocked this communication.", "format": "date-time" }, "canceledAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this delivery or workflow was canceled.", "format": "date-time" }, "cancelReason": { "type": [ "null", "string" ], "description": "Reason this delivery, run, or request was canceled." }, "errorCode": { "type": [ "null", "string" ], "description": "Machine-readable error code returned while processing this SMS event table row." }, "errorMessage": { "type": [ "null", "string" ], "description": "Human-readable error message returned while processing this SMS event table row." }, "isAutomated": { "type": "boolean", "description": "Indicates whether automation created or triggered this SMS event table row." }, "outboundSource": { "enum": [ "manual", "automation", "campaign", "import", "api", "system_notification", "warmup", "retry" ], "type": [ "null", "string" ], "description": "Defines the source that requested outbound delivery." }, "trafficType": { "enum": [ "RealLead", "Warmup", "Test", "SystemInternal", "FailedAttempt" ], "type": [ "null", "string" ], "description": "Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose." }, "billableAmount": { "type": [ "null", "number" ], "description": "Monetary amount billed for this Leadping communication or transaction.", "format": "double" }, "billingStatus": { "type": [ "null", "string" ], "description": "Billing state for this communication, charge, or transaction." }, "complianceAction": { "type": [ "null", "string" ], "description": "Compliance action applied to this message, lead, or sender." }, "consoleEntries": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CommunicationConsoleEntry" } ], "description": "Describes one durable diagnostic entry from the processing of a communication." }, "description": "Ordered diagnostic entries recorded while Leadping processed this message." }, "user": { "type": "string", "description": "User summary connected to this SMS event table row." }, "actorUserId": { "type": [ "null", "string" ], "description": "User ID for the actor that performed the action." }, "actorDisplayName": { "type": [ "null", "string" ], "description": "Display name for the actor that performed the action." }, "userName": { "type": [ "null", "string" ], "description": "Display name for the user connected to this SMS event table row." }, "senderName": { "type": [ "null", "string" ], "description": "Display name for the sender of this message." }, "organization": { "type": "string", "description": "Organization summary connected to this SMS event table row." }, "organizationName": { "type": [ "null", "string" ], "description": "Organization display name shown for this SMS event." } }, "description": "Summarizes SMS event data in paginated and searchable results." }, "SmsReadinessHealthStatus": { "enum": [ "Not Evaluated", "Evaluating", "Healthy", "Needs Attention", "Blocked" ], "type": "string", "description": "Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic." }, "SmsReadinessState": { "enum": [ "Not Started", "In Progress", "Paused", "Blocked", "Ready" ], "type": "string", "description": "Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping." }, "SmsReadinessStatusResponse": { "type": "object", "properties": { "phoneNumberId": { "type": "string", "description": "The phone number ID associated with this SMS warmup status." }, "phoneNumber": { "type": "string", "description": "The phone number associated with this SMS warmup status." }, "status": { "allOf": [ { "$ref": "#/components/schemas/SmsReadinessState" } ], "description": "The current state for this SMS warmup status." }, "healthStatus": { "allOf": [ { "$ref": "#/components/schemas/SmsReadinessHealthStatus" } ], "description": "The current delivery-health assessment for this SMS warmup status." }, "healthScore": { "type": "integer", "description": "The health score metric for this SMS warmup status.", "format": "int32" }, "progressPercent": { "type": "integer", "description": "The progress percent metric for this SMS warmup status.", "format": "int32" }, "warmupEnabled": { "type": "boolean", "description": "Whether warmup is enabled for this SMS warmup status." }, "uiState": { "allOf": [ { "$ref": "#/components/schemas/SmsReadinessUiState" } ], "description": "The current UI state for this SMS warmup status." } }, "description": "Describes SMS warmup status data returned by Leadping." }, "SmsReadinessUiState": { "type": "object", "properties": { "label": { "allOf": [ { "$ref": "#/components/schemas/SmsReadinessState" } ], "description": "The human-readable label shown for this SMS readiness UI state." }, "tone": { "type": "string", "description": "Tone for this SMS readiness UI state." }, "description": { "type": "string", "description": "The human-readable description of this SMS readiness UI state." } }, "description": "Describes SMS readiness UI state data used in Leadping API requests and responses." }, "SmsResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "Conversation ID that links this SMS message to the Leadping inbox thread." }, "leadId": { "type": "string", "description": "Lead ID associated with the SMS conversation or outreach attempt." }, "fromPhoneNumberId": { "type": "string", "description": "Sender phone number ID used for this outbound SMS or call." }, "outboundPhoneNumberId": { "type": "string", "description": "Phone number ID selected for outbound delivery." }, "fromPhoneNumber": { "type": [ "null", "string" ], "description": "Sender phone number used for this communication." }, "selectionReason": { "enum": [ "StickyConversation", "LeadAssigned", "CampaignOrSource", "Preferred", "LocalArea", "HealthyPool", "FallbackDefault", "ManualOverride" ], "type": [ "null", "string" ], "description": "Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number." }, "wasManuallyOverridden": { "type": "boolean", "description": "Indicates whether a user manually overrode Leadping's automatic number selection for this SMS message." }, "campaignId": { "type": [ "null", "string" ], "description": "Messaging campaign identifier associated with this SMS message." }, "sourceId": { "type": [ "null", "string" ], "description": "Lead source ID used for attribution and sender selection on this SMS message." }, "text": { "type": "string", "description": "Body text for the SMS message or communication represented by this SMS message." }, "media": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/MessageMediaAttachment" } ], "description": "Media attached to an SMS/MMS conversation event." }, "description": "Media attached to this message. A non-empty collection identifies an MMS message." }, "status": { "enum": [ "draft", "scheduled", "queued", "sending", "sent", "received", "delivered", "failed", "undeliverable", "opted_out", "blocked_compliance", "blocked_billing", "blocked_missing_campaign", "canceled" ], "type": [ "null", "string" ], "description": "Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure." }, "statusReason": { "type": [ "null", "string" ], "description": "Human-readable reason explaining the current status of this SMS message." }, "queuedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping queued this SMS message for processing.", "format": "date-time" }, "scheduledFor": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping is scheduled to send this SMS message.", "format": "date-time" }, "scheduledReason": { "type": [ "null", "string" ], "description": "Reason Leadping scheduled this delivery for a later time." }, "sendingStartedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping began sending this message.", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping sent this message to the provider.", "format": "date-time" }, "deliveredAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider confirmed delivery.", "format": "date-time" }, "receivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping received this inbound event or message.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when processing failed for this SMS message.", "format": "date-time" }, "undeliverableAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the provider marked the message undeliverable.", "format": "date-time" }, "blockedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping blocked this communication.", "format": "date-time" }, "nextRetryAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping will retry this SMS message.", "format": "date-time" }, "retryCount": { "type": "integer", "description": "Number of retry attempts already made for this SMS message.", "format": "int32" }, "canceledAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this delivery or workflow was canceled.", "format": "date-time" }, "cancelReason": { "type": [ "null", "string" ], "description": "Reason this delivery, run, or request was canceled." }, "errorCode": { "type": [ "null", "string" ], "description": "Machine-readable error code returned while processing this SMS message." }, "errorMessage": { "type": [ "null", "string" ], "description": "Human-readable error message returned while processing this SMS message." }, "trafficType": { "enum": [ "RealLead", "Warmup", "Test", "SystemInternal", "FailedAttempt" ], "type": [ "null", "string" ], "description": "Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose." }, "billableAmount": { "type": [ "null", "number" ], "description": "Monetary amount billed for this Leadping communication or transaction.", "format": "double" }, "billingStatus": { "type": [ "null", "string" ], "description": "Billing state for this communication, charge, or transaction." }, "complianceAction": { "type": [ "null", "string" ], "description": "Compliance action applied to this message, lead, or sender." }, "consoleEntries": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CommunicationConsoleEntry" } ], "description": "Describes one durable diagnostic entry from the processing of a communication." }, "description": "Ordered diagnostic entries recorded while Leadping processed this message." }, "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 an SMS or MMS message, including participants, delivery state, scheduling, media, and billing details." }, "SourceCredentialIssueResponse": { "type": "object", "properties": { "source": { "allOf": [ { "$ref": "#/components/schemas/SourceResponse" } ], "description": "Source metadata safe for later retrieval." }, "secret": { "type": "string", "description": "Newly issued source credential. Leadping does not retain this plaintext value." } }, "description": "Returns a newly issued source credential exactly once." }, "SourceMetricsResponse": { "type": "object", "properties": { "range": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsDateRange" } ], "description": "Range associated with this Leadping source metrics." }, "totalLeads": { "type": "integer", "description": "Total number of leads records represented by this Leadping source metrics.", "format": "int32" }, "totalErrors": { "type": "integer", "description": "Total number of lead intake errors represented by this Leadping source metrics.", "format": "int32" }, "points": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsTrendPointOfint" } ], "description": "Associates a typed analytics value with one normalized time bucket in a trend series." }, "description": "Collection of points included with this Leadping source metrics." }, "errorPoints": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsTrendPointOfint" } ], "description": "Associates a typed analytics value with one normalized time bucket in a trend series." }, "description": "Collection of lead intake error points included with this Leadping source metrics." }, "generatedAt": { "type": "string", "description": "Date and time when the source metrics was generated.", "format": "date-time" } }, "description": "Aggregates lead volume, conversion, delivery, and activity metrics attributed to a Leadping source over the requested reporting period." }, "SourceRequest": { "required": [ "allowedStates", "allowedProducts", "defaultTagIds", "defaultTagNames" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Human-readable source name." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this lead source request to API users." }, "allowedStates": { "type": "array", "items": { "type": "string" }, "description": "State or region allowlist used to accept leads from this source." }, "allowedProducts": { "type": "array", "items": { "type": "string" }, "description": "Product allowlist used to accept or route leads from this source." }, "requiresTrustedForm": { "type": "boolean", "description": "Indicates whether leads from this source must include a TrustedForm certificate for consent proof." }, "defaultTagIds": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs automatically assigned to leads created by this source." }, "defaultTagNames": { "type": "array", "items": { "type": "string" }, "description": "Tag names automatically assigned to leads created by this source." } }, "description": "Defines the fields clients can send when working with lead source." }, "SourceResponse": { "type": "object", "properties": { "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this lead source response to API users." }, "enabled": { "type": "boolean", "description": "Indicates whether this lead source response is active and available in the Leadping API." }, "apiKeyPreview": { "type": [ "null", "string" ], "description": "Masked preview of the source API key for compact display." }, "apiKeyRotatedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the source credential was most recently rotated.", "format": "date-time" }, "firstLeadReceivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this source first delivered a lead to Leadping.", "format": "date-time" }, "lastLeadReceivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this source most recently delivered a lead to Leadping.", "format": "date-time" }, "user": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary connected to this lead source response." }, "createdByUser": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary for the person who created this lead source response." }, "createdByUserEmail": { "type": [ "null", "string" ], "description": "Email used to resolve the creator's avatar.", "format": "email" }, "modifiedByUser": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary for the person who last modified this lead source response." }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Organization summary connected to this lead source response." }, "costPerLead": { "type": [ "null", "number" ], "description": "Configured cost charged when this source creates a billable lead.", "format": "double" }, "allowedStates": { "type": "array", "items": { "type": "string" }, "description": "State or region allowlist used to accept leads from this source." }, "allowedProducts": { "type": "array", "items": { "type": "string" }, "description": "Product allowlist used to accept or route leads from this source." }, "requiresTrustedForm": { "type": "boolean", "description": "Indicates whether leads from this source must include a TrustedForm certificate for consent proof." }, "complianceApproved": { "type": "boolean", "description": "Indicates whether the organization or sender passed compliance review." }, "defaultTagIds": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs automatically assigned to leads created by this source." }, "defaultTags": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/TagSummary" } ], "description": "Summary schema for Leadping API tag summary data used in dashboards and reports." }, "description": "Default tag summaries automatically applied to leads from this source." }, "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 lead source data returned by Leadping." }, "SourceTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this lead source table row." }, "name": { "type": "string", "description": "Display name for this lead source table row in the Leadping API." }, "description": { "type": "string", "description": "Human-readable description that explains this lead source table row to API users." }, "apiKeyPreview": { "type": "string", "description": "Masked preview of the source API key for compact display." }, "apiKeyRotatedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the source credential was most recently rotated.", "format": "date-time" }, "apiKeyLastUsedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the source API key was last used.", "format": "date-time" }, "apiKeyTotalUses": { "type": "integer", "description": "Total number of authenticated requests made with this source API key.", "format": "int64" }, "createdAt": { "type": "string", "description": "UTC timestamp when this lead source table row was created.", "format": "date-time" }, "modifiedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this lead source table row was last modified.", "format": "date-time" }, "firstLeadReceivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this source first delivered a lead to Leadping.", "format": "date-time" }, "lastLeadReceivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this source most recently delivered a lead to Leadping.", "format": "date-time" }, "enabled": { "type": "boolean", "description": "Indicates whether this lead source table row is active and available in the Leadping API." }, "user": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary connected to this lead source table row." }, "createdByUser": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary for the person who created this lead source table row." }, "modifiedByUser": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "User summary for the person who last modified this lead source table row." }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Organization summary connected to this lead source table row." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID that owns this lead source." }, "costPerLead": { "type": [ "null", "number" ], "description": "Configured cost charged when this source creates a billable lead.", "format": "double" }, "allowedStates": { "type": "array", "items": { "type": "string" }, "description": "State or region allowlist used to accept leads from this source." }, "allowedProducts": { "type": "array", "items": { "type": "string" }, "description": "Product allowlist used to accept or route leads from this source." }, "requiresTrustedForm": { "type": "boolean", "description": "Indicates whether leads from this source must include a TrustedForm certificate for consent proof." }, "complianceApproved": { "type": "boolean", "description": "Indicates whether the organization or sender passed compliance review." }, "defaultTagIds": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs automatically assigned to leads created by this source." }, "defaultTags": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/TagSummary" } ], "description": "Summary schema for Leadping API tag summary data used in dashboards and reports." }, "description": "Default tag summaries automatically applied to leads from this source." } }, "description": "Summarizes lead source data in paginated and searchable results." }, "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." }, "StripeInvoiceResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider identifier for the invoice." }, "number": { "type": [ "null", "string" ], "description": "Human-readable invoice number, when assigned." }, "createdAt": { "type": "string", "description": "Date and time when the invoice was created.", "format": "date-time" }, "amount": { "type": "number", "description": "Total invoice amount in the invoice currency.", "format": "double" }, "status": { "type": "string", "description": "Current provider-reported invoice status." }, "hasPdf": { "type": "boolean", "description": "Indicates whether a downloadable PDF is available for the invoice." } }, "description": "Customer-safe Leadping invoice summary for billing." }, "StripePaymentMethodResponse": { "required": [ "id", "brand", "last4" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this Stripe payment method." }, "brand": { "type": "string", "description": "Card network brand, such as Visa, Mastercard, or American Express." }, "last4": { "type": "string", "description": "Last four digits of the payment card number." }, "expMonth": { "type": "integer", "description": "Two-digit month when the card expires.", "format": "int32" }, "expYear": { "type": "integer", "description": "Four-digit year when the card expires.", "format": "int32" }, "isDefault": { "type": "boolean", "description": "Whether this Stripe payment method is default." }, "createdAt": { "type": [ "null", "string" ], "description": "UTC timestamp for created at on this Stripe payment method.", "format": "date-time" } }, "description": "Describes Stripe payment method data used in Leadping API requests and responses." }, "SuppressionCheckResult": { "type": "object", "properties": { "allowed": { "type": "boolean", "description": "Whether outreach to the recipient is allowed for the requested channel." }, "organizationId": { "type": [ "null", "string" ], "description": "Identifier of the organization whose suppression list was checked." }, "recipientIdentifier": { "type": [ "null", "string" ], "description": "Provider or customer identifier used to match the recipient." }, "normalizedPhoneNumber": { "type": [ "null", "string" ], "description": "Phone number used for matching, normalized to a consistent format." }, "normalizedEmail": { "type": [ "null", "string" ], "description": "Email address used for matching, normalized for comparison.", "format": "email" }, "channel": { "type": [ "null", "string" ], "description": "Communication channel evaluated by the suppression check." }, "suppressionEntryId": { "type": [ "null", "string" ], "description": "Identifier of the active suppression that blocked contact, when one matched." }, "source": { "type": [ "null", "string" ], "description": "The source value on the active suppression entry that blocked this check." }, "suppressedAt": { "type": [ "null", "string" ], "description": "The date and time the blocking suppression became active.", "format": "date-time" }, "customerReason": { "type": [ "null", "string" ], "description": "Customer-safe explanation of why contact is blocked or allowed." } }, "description": "Reports whether Leadping may contact a recipient and identifies the active suppression when contact is blocked." }, "SuppressionEntryAudit": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this suppression audit record." }, "status": { "type": "string", "description": "Suppression status established by this change, such as active or released." }, "source": { "type": "string", "description": "System or workflow that initiated the change." }, "timestamp": { "type": "string", "description": "UTC timestamp when the suppression change occurred.", "format": "date-time" }, "actorId": { "type": [ "null", "string" ], "description": "Identifier of the user or system actor responsible for the change." }, "reason": { "type": [ "null", "string" ], "description": "Human-readable reason recorded for the suppression change." }, "safeMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-sensitive metadata that provides additional audit context." } }, "description": "Records one auditable change to a recipient suppression entry." }, "SuppressionEntryRequest": { "type": "object", "properties": { "recipientIdentifier": { "type": [ "null", "string" ], "description": "Optional provider or customer identifier that uniquely identifies the recipient." }, "phoneNumber": { "type": [ "null", "string" ], "description": "Recipient phone number to suppress or check, preferably in E.164 format." }, "email": { "type": [ "null", "string" ], "description": "Recipient email address to suppress or check.", "format": "email" }, "channel": { "type": "string", "description": "Communication channel affected by the suppression, such as SMS, voice, email, or all channels." }, "reason": { "type": [ "null", "string" ], "description": "Human-readable reason for creating or releasing the suppression." } }, "description": "Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach." }, "SuppressionEntryResponse": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Unique Leadping identifier for the suppression entry." }, "organizationId": { "type": [ "null", "string" ], "description": "Identifier of the organization that owns the suppression entry." }, "recipientIdentifier": { "type": [ "null", "string" ], "description": "Provider or customer identifier used to recognize the suppressed recipient." }, "normalizedPhoneNumber": { "type": [ "null", "string" ], "description": "Suppressed phone number normalized to a consistent format." }, "normalizedEmail": { "type": [ "null", "string" ], "description": "Suppressed email address normalized for matching.", "format": "email" }, "channel": { "type": [ "null", "string" ], "description": "Communication channel affected by the suppression, such as SMS, voice, email, or all channels." }, "source": { "type": [ "null", "string" ], "description": "System or workflow that created the suppression." }, "status": { "type": [ "null", "string" ], "description": "Current lifecycle state, such as active or released." }, "reason": { "type": [ "null", "string" ], "description": "Human-readable reason the recipient was suppressed or subsequently released." }, "suppressedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the suppression became active.", "format": "date-time" }, "releasedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the suppression was released, or null while it remains active.", "format": "date-time" }, "audit": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/SuppressionEntryAudit" } ], "description": "Records one auditable change to a recipient suppression entry." }, "description": "Chronological audit history of suppression and release changes." } }, "description": "Describes a recipient suppression that prevents outreach through one or more communication channels." }, "TagRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Display name for this tag request in the Leadping API." }, "color": { "type": [ "null", "string" ], "description": "Hex color used to display this tag or status in Leadping clients." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this tag request to API users." }, "id": { "type": [ "null", "string" ], "description": "Stable unique identifier of an existing resource to update; omit it when the API assigns an identifier during creation." } }, "description": "Defines the fields clients can send when working with tag." }, "TagResponse": { "type": "object", "properties": { "organizationId": { "type": [ "null", "string" ], "description": "Organization ID that owns this tag." }, "name": { "type": "string", "description": "Display name for this tag response 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": { "type": [ "null", "string" ], "description": "Human-readable description that explains this tag response to API users." }, "createdByUserId": { "type": [ "null", "string" ], "description": "User ID of the person who created this tag response." }, "isArchived": { "type": "boolean", "description": "Indicates whether this lead or record is archived." }, "archivedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when this record was archived.", "format": "date-time" }, "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 tag data returned by Leadping." }, "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." }, "TelephonyLoginRequest": { "type": "object", "properties": { "device": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related device." } }, "description": "Identifies the Leadping user and calling context for which a short-lived telephony client token should be issued." }, "TelephonyLoginResponse": { "type": "object", "properties": { "username": { "type": "string", "description": "Username for this telephony login." }, "password": { "type": "string", "description": "Password for this telephony login." }, "expiresAt": { "type": [ "null", "string" ], "description": "UTC timestamp for expires at on this telephony login.", "format": "date-time" }, "callbackToken": { "type": "string", "description": "Callback token for this telephony login." } }, "description": "Provides the short-lived access token and client configuration required to initialize an authenticated Leadping calling session." }, "TenDlcApplicationDraft": { "type": "object", "properties": { "companyName": { "type": [ "null", "string" ], "description": "Company name for this 10DLC application draft." }, "contactName": { "type": [ "null", "string" ], "description": "Contact name for this 10DLC application draft." }, "contactEmail": { "type": [ "null", "string" ], "description": "Contact email for this 10DLC application draft.", "format": "email" }, "contactPhone": { "type": [ "null", "string" ], "description": "Contact phone for this 10DLC application draft." }, "ein": { "type": [ "null", "string" ], "description": "EIN for this 10DLC application draft." }, "websiteUrl": { "type": [ "null", "string" ], "description": "Public business website URL submitted to carriers during brand review.", "format": "uri" }, "industry": { "type": [ "null", "string" ], "description": "The Telnyx brand vertical for this 10DLC application draft. The JSON name is retained for backward compatibility." }, "useCase": { "type": [ "null", "string" ], "description": "Use case for this 10DLC application draft." }, "useCaseDescription": { "type": [ "null", "string" ], "description": "Use case description for this 10DLC application draft." }, "messageExamples": { "type": "array", "items": { "type": "string" }, "description": "The message examples included with this 10DLC application draft." }, "optInLanguage": { "type": [ "null", "string" ], "description": "Opt in language for this 10DLC application draft." }, "privacyPolicyUrl": { "type": [ "null", "string" ], "description": "Public privacy-policy URL that explains how messaging recipient data is handled.", "format": "uri" }, "termsUrl": { "type": [ "null", "string" ], "description": "Public terms-of-service URL governing the messaging program.", "format": "uri" }, "expectedMonthlyVolume": { "type": [ "null", "integer" ], "description": "Expected monthly volume for this 10DLC application draft.", "format": "int32" }, "trustedFormRequired": { "type": "boolean", "description": "Whether TrustedForm required applies to this 10DLC application draft." }, "complianceWarnings": { "type": "array", "items": { "type": "string" }, "description": "The compliance warnings included with this 10DLC application draft." }, "missingFields": { "type": "array", "items": { "type": "string" }, "description": "The missing fields included with this 10DLC application draft." }, "brandStatus": { "allOf": [ { "$ref": "#/components/schemas/TenDlcRegistrationStatus" } ], "description": "The current provider review status for the submitted brand." }, "campaignStatus": { "allOf": [ { "$ref": "#/components/schemas/TenDlcRegistrationStatus" } ], "description": "The current provider review status for the submitted campaign." }, "lastSubmittedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for last submitted at on this 10DLC application draft.", "format": "date-time" }, "rejectionReason": { "type": [ "null", "string" ], "description": "The human-readable rejection reason explaining this 10DLC application draft." }, "updatedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for updated at on this 10DLC application draft.", "format": "date-time" }, "version": { "type": "integer", "description": "Version for this 10DLC application draft.", "format": "int32" } }, "description": "Describes 10DLC application draft data used in Leadping API requests and responses." }, "TenDlcApplicationStatus": { "enum": [ "NotStarted", "DraftGenerated", "DraftIncomplete", "ReadyToSubmit", "Submitted", "PendingTelnyxReview", "Approved", "Rejected", "NeedsChanges", "ResubmissionReady", "Failed" ], "type": "string", "description": "Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission." }, "TenDlcNotesRequest": { "type": "object", "properties": { "notes": { "maxLength": 4000, "type": [ "null", "string" ], "description": "Notes to store with the 10DLC application, or null to clear them." } }, "description": "Updates the internal notes associated with a 10DLC application." }, "TenDlcRegistrationStatus": { "enum": [ "NotSubmitted", "Pending", "Approved", "Rejected", "Failed" ], "type": "string", "description": "Defines the provider lifecycle for an individual 10DLC brand or campaign." }, "TransactionResponse": { "type": "object", "properties": { "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related organization." }, "lead": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related lead." }, "amount": { "type": "number", "description": "Monetary amount for this billing transaction or wallet operation.", "format": "double" }, "netAmount": { "type": "number", "description": "Net monetary amount after fees, credits, or adjustments.", "format": "double" }, "billedAmount": { "type": "number", "description": "Customer-facing amount billed for the transaction.", "format": "double" }, "billingChannel": { "enum": [ "lead", "sms", "mms", "email", "voice", "phone_number", "warmup", "website", "openai", "domain", "10dlc", "payment", "connection", "automation" ], "type": [ "null", "string" ], "description": "Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage." }, "billableUnit": { "enum": [ "lead_received", "phone_identity_lookup", "sms_segment", "mms_message", "email_message", "voice_minute", "phone_number_month", "warmup_sms_segment", "warmup_voice_minute", "website_setup", "openai_operation", "domain_registration", "10dlc_application", "10dlc_campaign_month", "payment_processing_fee", "connection_action", "automation_run" ], "type": [ "null", "string" ], "description": "Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number." }, "gatewayFeeAmount": { "type": [ "null", "number" ], "description": "Payment gateway fee amount charged for the wallet transaction.", "format": "double" }, "gatewayStatus": { "type": [ "null", "string" ], "description": "Payment gateway status returned for this transaction." }, "platformFeeAmount": { "type": [ "null", "number" ], "description": "Leadping platform fee amount included in the transaction.", "format": "double" }, "notes": { "type": [ "null", "string" ], "description": "Additional billing notes that explain the transaction for admins or customers." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this billing transaction response to API users." }, "paymentMethodDisplay": { "type": [ "null", "string" ], "description": "Masked or human-readable payment method shown for this transaction." }, "transactionType": { "allOf": [ { "$ref": "#/components/schemas/TransactionType" } ], "description": "Debit or credit classification for this wallet transaction." }, "transactionStatus": { "allOf": [ { "$ref": "#/components/schemas/TransactionStatus" } ], "description": "Processing status for this wallet transaction." }, "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 billing transaction data returned by Leadping." }, "TransactionStatus": { "enum": [ "Pending", "Confirmed", "Failed" ], "type": "string", "description": "Describes the processing and settlement lifecycle of a Leadping wallet or billing transaction." }, "TransactionTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this billing transaction table row." }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related organization." }, "lead": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related lead." }, "amount": { "type": "number", "description": "Monetary amount for this billing transaction or wallet operation.", "format": "double" }, "netAmount": { "type": "number", "description": "Net monetary amount after fees, credits, or adjustments.", "format": "double" }, "billedAmount": { "type": "number", "description": "Customer-facing amount billed for the metered usage or wallet transaction.", "format": "double" }, "quantity": { "type": [ "null", "number" ], "description": "Number of billable units measured for this transaction, when usage-based pricing applies.", "format": "double" }, "unitPrice": { "type": [ "null", "number" ], "description": "Price charged per billable unit when usage-based pricing applies.", "format": "double" }, "billingChannel": { "enum": [ "lead", "sms", "mms", "email", "voice", "phone_number", "warmup", "website", "openai", "domain", "10dlc", "payment", "connection", "automation" ], "type": [ "null", "string" ], "description": "Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage." }, "billableUnit": { "enum": [ "lead_received", "phone_identity_lookup", "sms_segment", "mms_message", "email_message", "voice_minute", "phone_number_month", "warmup_sms_segment", "warmup_voice_minute", "website_setup", "openai_operation", "domain_registration", "10dlc_application", "10dlc_campaign_month", "payment_processing_fee", "connection_action", "automation_run" ], "type": [ "null", "string" ], "description": "Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number." }, "sourceEventId": { "type": [ "null", "string" ], "description": "Identifier of the event that created this billing transaction, when available." }, "sourceEventType": { "type": [ "null", "string" ], "description": "Event type that created this billing transaction, when available." }, "pricingVersion": { "type": [ "null", "string" ], "description": "Version of the pricing rules used to calculate the billed amount." }, "transactionType": { "allOf": [ { "$ref": "#/components/schemas/TransactionType" } ], "description": "Debit or credit classification for this wallet transaction." }, "transactionStatus": { "allOf": [ { "$ref": "#/components/schemas/TransactionStatus" } ], "description": "Processing status for this wallet transaction." }, "paymentMethodDisplay": { "type": [ "null", "string" ], "description": "Masked or human-readable payment method shown for this transaction." }, "description": { "type": [ "null", "string" ], "description": "Human-readable description that explains this billing transaction table row to API users." }, "createdAt": { "type": "string", "description": "UTC timestamp when this billing transaction table row was created.", "format": "date-time" } }, "description": "Summarizes billing transaction data in paginated and searchable results." }, "TransactionType": { "enum": [ "Debit", "Adjustment", "Deposit" ], "type": "string", "description": "Classifies a wallet transaction as a debit, credit, refund, adjustment, deposit, or other balance movement." }, "TrustedFormCertificate": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Unique Leadping identifier for this TrustedForm certificate." }, "url": { "type": "string", "description": "The URL associated with this TrustedForm certificate.", "format": "uri" }, "source": { "type": [ "null", "string" ], "description": "Source for this TrustedForm certificate." }, "createdAt": { "type": [ "null", "string" ], "description": "UTC timestamp for created at on this TrustedForm certificate.", "format": "date-time" } }, "description": "Describes trusted form certificate data used in Leadping API requests and responses." }, "UsageChannel": { "enum": [ "lead", "sms", "mms", "email", "voice", "phone_number", "warmup", "website", "openai", "domain", "10dlc", "payment", "connection", "automation" ], "type": "string", "description": "Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage." }, "UsageCounterLine": { "type": "object", "properties": { "key": { "type": "string", "description": "The stable key for this usage counter." }, "label": { "type": "string", "description": "The human-readable label for this usage counter." }, "value": { "type": "number", "description": "Numeric for this usage counter.", "format": "double" }, "unit": { "type": "string", "description": "The unit label for this usage counter." }, "sortOrder": { "type": "integer", "description": "The display order for this usage counter.", "format": "int32" } }, "description": "Describes one named usage total displayed in organization billing and activity summaries." }, "UsageLedgerTableRow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for this usage ledger." }, "organization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related organization." }, "user": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related user." }, "lead": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Identifier and display name of the related lead." }, "phoneNumberId": { "type": [ "null", "string" ], "description": "The phone number ID associated with this usage ledger." }, "phoneNumber": { "type": [ "null", "string" ], "description": "The phone number associated with this usage ledger." }, "channel": { "allOf": [ { "$ref": "#/components/schemas/UsageChannel" } ], "description": "Channel for this usage ledger." }, "billableUnit": { "allOf": [ { "$ref": "#/components/schemas/BillableUnit" } ], "description": "Billable unit for this usage ledger." }, "status": { "allOf": [ { "$ref": "#/components/schemas/UsageStatus" } ], "description": "The current status for this usage ledger." }, "quantity": { "type": "number", "description": "Quantity for this usage ledger.", "format": "double" }, "durationSeconds": { "type": [ "null", "integer" ], "description": "Duration seconds for this usage ledger.", "format": "int32" }, "billableSeconds": { "type": [ "null", "integer" ], "description": "Billable seconds for this usage ledger.", "format": "int32" }, "smsSegments": { "type": [ "null", "integer" ], "description": "SMS segments for this usage ledger.", "format": "int32" }, "unitPrice": { "type": "number", "description": "Unit price for this usage ledger.", "format": "double" }, "customerChargeAmount": { "type": "number", "description": "The monetary customer charge amount for this usage ledger.", "format": "double" }, "isBillable": { "type": "boolean", "description": "Whether this usage ledger is billable." }, "description": { "type": [ "null", "string" ], "description": "The human-readable description of this usage ledger." }, "createdAt": { "type": "string", "description": "UTC timestamp for created at on this usage ledger.", "format": "date-time" } }, "description": "Describes usage ledger data used in Leadping API requests and responses." }, "UsageStatus": { "enum": [ "recorded", "rated", "pending_invoice", "invoiced", "charged", "failed", "refunded_credited", "non_billable_internal", "blocked_due_to_billing" ], "type": "string", "description": "Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed." }, "UsageSummaryLine": { "type": "object", "properties": { "channel": { "allOf": [ { "$ref": "#/components/schemas/UsageChannel" } ], "description": "Channel for this usage summary line." }, "billableUnit": { "allOf": [ { "$ref": "#/components/schemas/BillableUnit" } ], "description": "Billable unit for this usage summary line." }, "status": { "allOf": [ { "$ref": "#/components/schemas/UsageStatus" } ], "description": "The current status for this usage summary line." }, "quantity": { "type": "number", "description": "Quantity for this usage summary line.", "format": "double" }, "customerChargeAmount": { "type": "number", "description": "The monetary customer charge amount for this usage summary line.", "format": "double" }, "recordCount": { "type": "integer", "description": "The record count for this usage summary line.", "format": "int32" } }, "description": "Describes usage summary line data used in Leadping API requests and responses." }, "UsageSummaryResponse": { "type": "object", "properties": { "periodStart": { "type": "string", "description": "UTC timestamp for period start on this usage summary.", "format": "date-time" }, "periodEnd": { "type": "string", "description": "UTC timestamp for period end on this usage summary.", "format": "date-time" }, "customerChargeTotal": { "type": "number", "description": "The customer charge total for this usage summary.", "format": "double" }, "billableQuantityTotal": { "type": "number", "description": "The billable quantity total for this usage summary.", "format": "double" }, "transactionCount": { "type": "integer", "description": "The usage record count for this usage summary.", "format": "int32" }, "pendingInvoiceCount": { "type": "integer", "description": "The pending invoice count for this usage summary.", "format": "int32" }, "failedCount": { "type": "integer", "description": "The failed count for this usage summary.", "format": "int32" }, "lines": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/UsageSummaryLine" } ], "description": "Describes usage summary line data used in Leadping API requests and responses." }, "description": "The lines included with this usage summary." }, "counters": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/UsageCounterLine" } ], "description": "Describes one named usage total displayed in organization billing and activity summaries." }, "description": "The named usage counters included with this usage summary." } }, "description": "Describes usage summary response data used by Leadping." }, "UserCompliance": { "type": "object", "properties": { "acceptedTerms": { "type": "boolean", "description": "Whether the user accepted terms for this user compliance." }, "acceptedToSubscription": { "type": "boolean", "description": "Whether the user accepted subscription for this user compliance." }, "acceptedSms": { "type": "boolean", "description": "Whether the user accepted SMS for this user compliance." }, "acceptedBaa": { "type": "boolean", "description": "Whether the user accepted BAA for this user compliance." }, "acceptedEmail": { "type": "boolean", "description": "Whether the user accepted email for this user compliance." }, "trustedFormCertificates": { "type": [ "null", "array" ], "items": { "allOf": [ { "$ref": "#/components/schemas/TrustedFormCertificate" } ], "description": "Describes trusted form certificate data used in Leadping API requests and responses." }, "description": "The TrustedForm certificates included with this user compliance." } }, "description": "Describes user compliance data used in Leadping API requests and responses." }, "UserDataExportDownloadResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "URL for accessing the associated resource.", "format": "uri" } }, "description": "Provides the temporary download location and expiration details for a completed Leadping user-data export." }, "UserDataExportFile": { "type": "object", "properties": { "category": { "type": "string", "description": "Category classification for this Leadping user data export file." }, "fileName": { "type": "string", "description": "Human-readable file name associated with this Leadping user data export file." }, "contentType": { "type": "string", "description": "Media type of the generated file or response content." }, "rowCount": { "type": "integer", "description": "Total number of row records represented by this Leadping user data export file.", "format": "int32" } }, "description": "Describes a file included in a user-data export, including its logical category, media type, size, and integrity metadata." }, "UserDataExportResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Leadping identifier for the user data export." }, "status": { "allOf": [ { "$ref": "#/components/schemas/UserDataExportStatuses" } ], "description": "Current status for this Leadping user data export." }, "requestedAt": { "type": "string", "description": "Date and time when the user data export was requested.", "format": "date-time" }, "startedAt": { "type": [ "null", "string" ], "description": "Date and time when the user data export started.", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "description": "Date and time when the user data export completed.", "format": "date-time" }, "failedAt": { "type": [ "null", "string" ], "description": "Date and time when the user data export failed.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "Date and time when the user data export expires.", "format": "date-time" }, "message": { "type": [ "null", "string" ], "description": "Human-readable message for this Leadping user data export." }, "downloadUrl": { "type": [ "null", "string" ], "description": "Temporary URL for downloading the completed Leadping data export.", "format": "uri" }, "fileName": { "type": [ "null", "string" ], "description": "Human-readable file name associated with this Leadping user data export." }, "contentType": { "type": [ "null", "string" ], "description": "Media type of the generated file or response content." }, "sizeBytes": { "type": [ "null", "integer" ], "description": "Size of the generated export archive in bytes, when the export is ready.", "format": "int64" }, "downloadCount": { "type": "integer", "description": "Total number of download records represented by this Leadping user data export.", "format": "int32" }, "maxDownloadCount": { "type": "integer", "description": "Total number of max download records represented by this Leadping user data export.", "format": "int32" }, "files": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/UserDataExportFile" } ], "description": "Describes a file included in a user-data export, including its logical category, media type, size, and integrity metadata." }, "description": "Collection of files included with this Leadping user data export." } }, "description": "Describes the lifecycle, scope, progress, retention, and downloadable artifacts of a Leadping user-data export request." }, "UserDataExportStatuses": { "enum": [ "Pending", "Processing", "Completed", "Failed", "Expired" ], "type": "string", "description": "Identifies the preparation, availability, failure, expiration, or deletion stage of a Leadping user-data export." }, "UserIdentity": { "type": "object", "properties": { "issuer": { "type": "string", "description": "Identity provider or tenant that issued the sign-in identity, such as contoso.com or facebook.com." }, "issuerAssignedId": { "type": "string", "description": "Stable unique user identifier assigned by the identity provider within the issuer's namespace." }, "signInType": { "type": "string", "description": "Sign-in method represented by the identity, such as emailAddress, userName, or federated." } }, "description": "Identifies an external sign-in identity linked to a Leadping user, including its provider, provider-assigned user identifier, and authentication method." }, "UserNotificationPreferences": { "type": "object", "properties": { "smsConsentOptedIn": { "type": [ "null", "boolean" ], "description": "Whether the user has consented to receive Leadping account notification SMS messages." }, "smsConsentUpdatedAt": { "type": [ "null", "string" ], "description": "When the user's Leadping notification SMS consent was last changed.", "format": "date-time" }, "smsConsentTrustedFormCertificate": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/TrustedFormCertificate" } ], "description": "The TrustedForm certificate captured for the user's most recent SMS opt-in." }, "paymentFailedEnabled": { "type": "boolean", "description": "Whether payment failed notifications are enabled for this user notification preferences." }, "paymentFailedSmsEnabled": { "type": "boolean", "description": "Indicates whether payment failed SMS functionality is enabled for this Leadping user notification preferences." }, "lowWalletBalanceEnabled": { "type": "boolean", "description": "Whether low wallet balance notifications are enabled for this user notification preferences." }, "lowWalletBalanceEmailEnabled": { "type": "boolean", "description": "Indicates whether low wallet balance email functionality is enabled for this Leadping user notification preferences." }, "lowWalletBalanceSmsEnabled": { "type": "boolean", "description": "Indicates whether low wallet balance SMS functionality is enabled for this Leadping user notification preferences." }, "tenDlcStatusEnabled": { "type": "boolean", "description": "Whether 10DLC status notifications are enabled for this user notification preferences." }, "newLeadEnabled": { "type": "boolean", "description": "Whether new lead notifications are enabled for this user notification preferences." }, "newLeadEmailEnabled": { "type": "boolean", "description": "Whether new lead email is enabled for this user notification preferences." }, "newLeadSmsEnabled": { "type": "boolean", "description": "Whether new lead SMS is enabled for this user notification preferences." }, "missedCallEnabled": { "type": "boolean", "description": "Whether missed call notifications are enabled for this user notification preferences." }, "missedCallEmailEnabled": { "type": "boolean", "description": "Indicates whether missed call email functionality is enabled for this Leadping user notification preferences." }, "missedCallSmsEnabled": { "type": "boolean", "description": "Indicates whether missed call SMS functionality is enabled for this Leadping user notification preferences." }, "unreadSmsEnabled": { "type": "boolean", "description": "Whether unread SMS notifications are enabled for this user notification preferences." }, "unreadSmsEmailEnabled": { "type": "boolean", "description": "Indicates whether unread SMS email functionality is enabled for this Leadping user notification preferences." }, "unreadSmsSmsEnabled": { "type": "boolean", "description": "Indicates whether unread SMS SMS functionality is enabled for this Leadping user notification preferences." }, "automationFailedEnabled": { "type": "boolean", "description": "Whether automation failed notifications are enabled for this user notification preferences." }, "automationFailedEmailEnabled": { "type": "boolean", "description": "Indicates whether automation failed email functionality is enabled for this Leadping user notification preferences." }, "automationFailedSmsEnabled": { "type": "boolean", "description": "Indicates whether automation failed SMS functionality is enabled for this Leadping user notification preferences." }, "billingEmailEnabled": { "type": "boolean", "description": "Whether billing email is enabled for this user notification preferences." }, "billingSmsEnabled": { "type": "boolean", "description": "Whether billing SMS is enabled for this user notification preferences." }, "subscriptionRenewingEnabled": { "type": "boolean", "description": "Whether subscription renewing notifications are enabled for this user notification preferences." }, "subscriptionRenewingEmailEnabled": { "type": "boolean", "description": "Indicates whether subscription renewing email functionality is enabled for this Leadping user notification preferences." }, "subscriptionRenewingSmsEnabled": { "type": "boolean", "description": "Indicates whether subscription renewing SMS functionality is enabled for this Leadping user notification preferences." }, "usageLimitHitEnabled": { "type": "boolean", "description": "Whether usage limit hit notifications are enabled for this user notification preferences." } }, "description": "Describes user notification preferences data used in Leadping API requests and responses." }, "UserRequest": { "required": [ "phone" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Display name for the user." }, "firstName": { "type": [ "null", "string" ], "description": "First name of the lead, user, or contact represented by this user profile request." }, "lastName": { "type": [ "null", "string" ], "description": "Last name of the lead, user, or contact represented by this user profile request." }, "phone": { "type": "string", "description": "Phone details for the lead, user, or organization represented by this user profile request." }, "timeZoneId": { "type": [ "null", "string" ], "description": "IANA time zone identifier used when displaying dates and times for this user." }, "notificationPreferences": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/UserNotificationPreferences" } ], "description": "Notification preferences configured for the user." } }, "description": "Defines the fields clients can send when working with user profile." }, "UserResponse": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address associated with this user.", "format": "email" }, "firstName": { "type": [ "null", "string" ], "description": "First name for this user." }, "lastName": { "type": [ "null", "string" ], "description": "Last name of the Leadping user." }, "phone": { "type": [ "null", "string" ], "description": "The phone number associated with this user." }, "timeZoneId": { "type": [ "null", "string" ], "description": "IANA time zone identifier used when displaying dates and times for this user." }, "billingPlan": { "enum": [ "Annual", "Monthly" ], "type": [ "null", "string" ], "description": "Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior." }, "subscriptionStatus": { "enum": [ "Pending", "Active", "Overdue", "Canceled" ], "type": [ "null", "string" ], "description": "Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states." }, "billingState": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/OrganizationBillingState" } ], "description": "Customer-safe billing state for the user's currently selected organization." }, "roles": { "type": [ "null", "array" ], "items": { "type": "string", "description": "A Leadping user role value." }, "description": "The roles included with this user." }, "identities": { "type": [ "null", "array" ], "items": { "allOf": [ { "$ref": "#/components/schemas/UserIdentity" } ], "description": "Identifies an external sign-in identity linked to a Leadping user, including its provider, provider-assigned user identifier, and authentication method." }, "description": "The identities included with this user." }, "currentOrganization": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/IdNamePair" } ], "description": "Current organization for this user." }, "compliance": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/UserCompliance" } ], "description": "Compliance for this user." }, "notificationPreferences": { "type": [ "null", "object" ], "allOf": [ { "$ref": "#/components/schemas/UserNotificationPreferences" } ], "description": "Notification preferences for this user." }, "mobileDevicePreferences": { "type": [ "null", "array" ], "items": { "allOf": [ { "$ref": "#/components/schemas/MobileDevicePreferences" } ], "description": "Describes notification and calling preferences saved for one of the user's mobile devices." }, "description": "The Leadping mobile device preferences for this user." }, "lastLoggedInAt": { "type": [ "null", "string" ], "description": "The date and time when this user last completed the Leadping sign-in flow.", "format": "date-time" }, "personalDataDeletionRequestedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for personal data deletion requested at on this user.", "format": "date-time" }, "personalDataDeletedAt": { "type": [ "null", "string" ], "description": "UTC timestamp for personal data deleted at on this user.", "format": "date-time" }, "personalDataDeletionStatus": { "type": [ "null", "string" ], "description": "The current personal data deletion status for this user." }, "personalDataDeletionReason": { "type": [ "null", "string" ], "description": "The human-readable personal data deletion reason explaining this user." }, "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 user data returned by Leadping." }, "WalletResponse": { "type": "object", "properties": { "balance": { "type": [ "null", "number" ], "description": "Wallet or account balance after this transaction is applied.", "format": "double" }, "balanceCalculatedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when Leadping last calculated the wallet balance.", "format": "date-time" }, "amountPurchased": { "type": [ "null", "number" ], "description": "Amount of wallet credit purchased in this deposit.", "format": "double" }, "amountRemaining": { "type": [ "null", "number" ], "description": "Amount of wallet credit still available for future usage.", "format": "double" }, "currency": { "type": [ "null", "string" ], "description": "ISO currency code used for the monetary amounts in this billing wallet response." }, "purchasedAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the wallet credit was purchased.", "format": "date-time" }, "expiresAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the wallet credit expires.", "format": "date-time" }, "sourceType": { "enum": [ "purchase", "promo", "admin_adjustment", "refund_adjustment", "chargeback_reversal", "compromise_restoration" ], "type": [ "null", "string" ], "description": "Defines the source that created a wallet credit lot." }, "creditStatus": { "enum": [ "active", "consumed", "expired", "refunded", "voided", "disputed" ], "type": [ "null", "string" ], "description": "Defines the lifecycle state for a wallet credit lot." }, "organizationId": { "type": [ "null", "string" ], "description": "Organization ID that owns this wallet balance or credit." }, "originalTransactionId": { "type": [ "null", "string" ], "description": "Original wallet transaction ID referenced by a reversal, refund, or adjustment." }, "nextCreditExpirationAt": { "type": [ "null", "string" ], "description": "UTC timestamp when the next wallet credit amount expires.", "format": "date-time" }, "nextExpiringCreditAmount": { "type": [ "null", "number" ], "description": "Amount of wallet credit scheduled to expire next.", "format": "double" }, "expiredCreditAmount": { "type": [ "null", "number" ], "description": "Amount of wallet credit that has expired.", "format": "double" }, "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 billing wallet data returned by Leadping." }, "WebsiteLifecycleStatus": { "enum": [ "NotStarted", "DomainSuggestionsPending", "DomainSelectionPending", "DomainPurchasePending", "DomainPurchased", "WebsiteGenerationQueued", "WebsiteGenerating", "WebsiteDeploymentQueued", "WebsiteDeploying", "WebsiteLive", "WebsiteFailed", "ManuallyBypassed" ], "type": "string", "description": "Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal." } }, "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" }, "SourceKey": { "type": "http", "description": "Leadping source key for lead ingestion endpoints only using the Authorization header. Example: \"Authorization: Bearer lp_src_...\".", "scheme": "bearer", "bearerFormat": "Leadping source key" } } }, "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" }, "webhooks": { "automationDelivery": { "summary": "Leadping automation webhook delivery", "description": "A configurable outbound HTTP request sent by a Leadping automation to a consumer-operated HTTPS endpoint.", "get": { "summary": "Receive an automation webhook using GET", "description": "Receives a consumer-configured Leadping automation request. Correlation headers are for tracing and deduplication, not authentication or proof of origin.", "operationId": "AutomationWebhook_Get", "parameters": [ { "name": "X-Leadping-Event", "in": "header", "description": "Automation trigger event type.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Automation-Id", "in": "header", "description": "Identifier of the automation that sent the request.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Run-Id", "in": "header", "description": "Stable automation-run identifier reused across retries.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Action-Id", "in": "header", "description": "Identifier of the webhook action within the automation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The consumer accepted and processed the delivery." }, "202": { "description": "The consumer accepted the delivery for asynchronous processing." } }, "security": [ ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": false }, "authorization": { "source": "Consumer-configured webhook authentication" }, "audit": { "recommended": true } } }, "post": { "summary": "Receive an automation webhook using POST", "description": "Receives a consumer-configured Leadping automation request. Correlation headers are for tracing and deduplication, not authentication or proof of origin.", "operationId": "AutomationWebhook_Post", "parameters": [ { "name": "X-Leadping-Event", "in": "header", "description": "Automation trigger event type.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Automation-Id", "in": "header", "description": "Identifier of the automation that sent the request.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Run-Id", "in": "header", "description": "Stable automation-run identifier reused across retries.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Action-Id", "in": "header", "description": "Identifier of the webhook action within the automation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Consumer-configured rendered body. Its shape is defined by the automation, not by Leadping.", "content": { "application/json": { "schema": { }, "example": { "event": "lead.updated", "leadId": "lead-123" } }, "text/plain": { "schema": { "type": "string" }, "example": "Lead lead-123 was updated" } }, "required": true }, "responses": { "200": { "description": "The consumer accepted and processed the delivery." }, "202": { "description": "The consumer accepted the delivery for asynchronous processing." } }, "security": [ ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": false }, "authorization": { "source": "Consumer-configured webhook authentication" }, "audit": { "recommended": true } } }, "put": { "summary": "Receive an automation webhook using PUT", "description": "Receives a consumer-configured Leadping automation request. Correlation headers are for tracing and deduplication, not authentication or proof of origin.", "operationId": "AutomationWebhook_Put", "parameters": [ { "name": "X-Leadping-Event", "in": "header", "description": "Automation trigger event type.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Automation-Id", "in": "header", "description": "Identifier of the automation that sent the request.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Run-Id", "in": "header", "description": "Stable automation-run identifier reused across retries.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Action-Id", "in": "header", "description": "Identifier of the webhook action within the automation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Consumer-configured rendered body. Its shape is defined by the automation, not by Leadping.", "content": { "application/json": { "schema": { }, "example": { "event": "lead.updated", "leadId": "lead-123" } }, "text/plain": { "schema": { "type": "string" }, "example": "Lead lead-123 was updated" } }, "required": true }, "responses": { "200": { "description": "The consumer accepted and processed the delivery." }, "202": { "description": "The consumer accepted the delivery for asynchronous processing." } }, "security": [ ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": false }, "authorization": { "source": "Consumer-configured webhook authentication" }, "audit": { "recommended": true } } }, "patch": { "summary": "Receive an automation webhook using PATCH", "description": "Receives a consumer-configured Leadping automation request. Correlation headers are for tracing and deduplication, not authentication or proof of origin.", "operationId": "AutomationWebhook_Patch", "parameters": [ { "name": "X-Leadping-Event", "in": "header", "description": "Automation trigger event type.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Automation-Id", "in": "header", "description": "Identifier of the automation that sent the request.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Run-Id", "in": "header", "description": "Stable automation-run identifier reused across retries.", "required": true, "schema": { "type": "string" } }, { "name": "X-Leadping-Action-Id", "in": "header", "description": "Identifier of the webhook action within the automation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Consumer-configured rendered body. Its shape is defined by the automation, not by Leadping.", "content": { "application/json": { "schema": { }, "example": { "event": "lead.updated", "leadId": "lead-123" } }, "text/plain": { "schema": { "type": "string" }, "example": "Lead lead-123 was updated" } }, "required": true }, "responses": { "200": { "description": "The consumer accepted and processed the delivery." }, "202": { "description": "The consumer accepted the delivery for asynchronous processing." } }, "security": [ ], "x-agentic-access": { "action-class": "acting", "consequences": [ "physical" ], "subject": { "required": false }, "authorization": { "source": "Consumer-configured webhook authentication" }, "audit": { "recommended": true } } } } } }