Lead Generation - API Documentation

App Command (API Call)
POST your request to https://api.aiappsapi.com with your API key and account ID in the POST body. The fields described in each section below go inside the jsonData POST field as a JSON-encoded string. Use this method when your server is making the call and you have your API credentials available.

Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required, the account ID is part of the URL.

The main inbound endpoint for offer form submissions. When an offerID is provided, validates required fields, stores the lead profile, forwards data to third-party buyers if host-and-post is configured, auto-submits other path offers when all required data is already available, and returns the next offer in the path. When only an offerpathID is provided (no offerID), starts or resumes the path and returns the first available offer.

Accepts completed survey answers and stores them in the lead database. Each submission is stored as a separate record. On hosted websites, surveys are multi-page forms that submit page by page and store the final result automatically. Use this mode endpoint when submitting survey answers from an external system.

Accepts completed application answers and stores them in the lead database. Works identically to the survey submission endpoint but stores records with an application type. On hosted websites, applications are multi-page forms handled automatically. Use this mode endpoint when submitting application answers from an external system.

Returns all active offers tagged with a given vertical. Use this to retrieve the list of available offers for a specific category or market vertical. Only offers with an active status are returned.

Returns the full lead profile for a given record ID. The record includes all stored contact fields, custom data, and a history of which offers the lead has completed.

Single command for managing offer path state, used primarily by the AI Chatbot for conversational lead collection. Handles both state retrieval and updates in one call. If a field name and value or skip flag is provided, processes the update first, then always returns the current path state: the next offer to present, which fields are still missing, or a completion flag when all offers are done.