> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create an organization lead follow-up automation > Creates an automation for current-organization leads, configuring triggers, message steps, and follow-up behavior. ## OpenAPI ````yaml /openapi.json post /automations openapi: 3.1.1 info: title: Leadping API description: >- The Leadping API helps businesses capture and manage leads, automate follow-up, send SMS and MMS messages, place calls, track conversations, enforce contact suppression, and analyze communication workflows. Use this OpenAPI 3.1 contract to integrate lead sources, build organization tools, or generate a typed API client. Authenticate protected operations with a Leadping user access token or WorkOS organization API key. Lead intake operations also accept a Leadping source key. termsOfService: https://leadping.ai/docs/terms-of-service contact: name: Leadping Support url: https://leadping.ai/contact email: support@leadping.ai license: name: MIT url: https://opensource.org/licenses/MIT version: v1 summary: Lead management, messaging, calling, and automation API servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: leadping.Api description: >- Agent-to-agent discovery and request handling for Leadping's supported AI agent integrations. - name: Analytics description: >- Provides lead, communication, conversion, and organization performance analytics. Use these endpoints to measure activity over time, compare outcomes, and power operational dashboards and reporting workflows. - name: Automations description: >- Manages automated lead follow-up workflows and their execution history. Use these endpoints to configure SMS automation steps, preview eligible leads, run workflows, and inspect individual automation executions. - name: BlogArticles description: >- Provides published Leadping blog content. Use these endpoints to list published articles and retrieve an individual article by its public slug. - name: Conversations description: >- Provides lead conversation timelines and inbox-oriented conversation views. Use these endpoints to list recent conversations and retrieve the cross-channel communication history associated with a lead. - name: Feedback description: >- Captures Leadping product feedback and supports administrative triage. Users can submit feedback, while authorized staff can search, inspect, classify, and update feedback throughout the review process. - name: Leads description: >- Manages lead intake, records, assignment, routing, and lifecycle operations. Use these endpoints to ingest leads from trusted sources, search and update lead records, manage ownership and tags, and archive or delete leads. - name: LeadStatusChanges description: >- Manages the auditable history of lead status transitions. Use these endpoints to change a lead's status, correct transition records, search status history, and export status activity for reporting. - name: LeadStatuses description: >- Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting. - name: Notifications description: >- Manages user notifications, announcements, and push-notification installations. Use these endpoints to retrieve notification feeds and unread counts, update read state, and register or remove client push installations. - name: OutboundDelivery description: >- Reports outbound delivery pacing and sending capacity for the current organization. Use these endpoints to determine whether outbound communications can proceed and to understand active throttles, limits, or capacity constraints. - name: Sources description: >- Manages lead sources, intake credentials, routing defaults, and attribution. Use these endpoints to create and configure sources, search source records, inspect source activity, rotate intake access, and remove obsolete sources. - name: Suppressions description: >- Manages recipient suppression state for compliant Leadping communication workflows. Use these endpoints to check contact eligibility, record or release suppressions, and review suppression history before sending messages or placing calls. - name: Tags description: >- Manages organization-defined tags for categorizing and routing leads. Use these endpoints to list, create, update, and archive reusable tags that support lead filtering, automation, assignment, and reporting. - name: Users description: >- Manages the current Leadping user's profile, preferences, setup, and account workflows. Use these endpoints to retrieve and update user data, configure communication and compliance preferences, complete onboarding, manage plan-related actions, and request account operations. - name: Calls description: >- Manages outbound Leadping calls and active call-control workflows. Use these endpoints to initiate or cancel a call, retrieve call state, and transfer an active call within supported telephony flows. - name: PhoneNumbers description: >- Manages phone-number discovery, purchasing, assignment, configuration, and compliance. Use these endpoints to search available numbers, manage owned numbers and caller identity, configure messaging or voice behavior, and monitor registration and warmup state. - name: Sms description: >- Sends and manages SMS and MMS communications through Leadping. Use these endpoints to send messages, upload MMS media, and cancel eligible scheduled messages while preserving conversation and delivery tracking. - name: Telephony description: >- Provides shared authentication and bootstrap data for Leadping telephony clients. Use this endpoint to obtain the scoped credentials and configuration required to initialize supported calling experiences. - name: Organizations description: >- Manages Leadping organizations, memberships, invitations, settings, and API credentials. Use these endpoints to maintain organization profiles and branding, manage members and invitations, configure options, and issue or revoke organization API keys. - name: UserDataExports description: >- Creates and delivers user-requested exports of Leadping account data. Use these endpoints to request an export, monitor its preparation status, and download the completed archive through a time-limited redirect. - name: CallEvents description: >- Provides call event records for auditing, diagnostics, and reporting. Use these endpoints to search and inspect lifecycle events emitted as Leadping calls are initiated, connected, completed, or fail. - name: Events description: >- Provides a unified record of Leadping activity across communication channels. Use these endpoints to retrieve event timelines, search event history, inspect event details, and record supported application events. - name: SmsEvents description: >- Provides SMS and MMS event records for delivery tracking and diagnostics. Use these endpoints to search and inspect message lifecycle events, including outbound delivery updates and inbound messaging activity. - name: PaymentMethods description: >- Manages organization payment methods and billing invoices. Use these endpoints to add, confirm, inspect, and remove payment methods or retrieve invoices associated with the current organization's billing account. - name: Transactions description: >- Provides organization wallet and billing transaction records. Use these endpoints to search transaction history, inspect individual charges or credits, review transaction summaries, and issue administrative credits. - name: Usage description: >- Provides billable usage records for Leadping services. Use these endpoints to review messaging and calling consumption, inspect usage summaries, and reconcile provider activity for an organization. - name: Wallets description: >- Manages organization wallet balances, funding, and credit activity. Use these endpoints to inspect wallet state and history, configure wallet behavior, add funds, and record credits or adjustments. externalDocs: description: >- Leadping API documentation, authentication guide, concepts, and integration guidance. url: https://leadping.ai/docs/api-reference paths: /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: [] components: schemas: 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. 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. 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. 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. 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. 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. 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. 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. 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. 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 ````