Skip to content

Forms

Operations

Submit Form

Request

Accepts form submissions and immediately enriches and dispositions the data.

Overview

The Form Submit API is designed to accept form submissions directly from marketing automation platforms or websites. It provides immediate enrichment and disposition of submitted data with two possible outcomes:

  1. Return enriched lead data in the response
  2. Push the enriched lead to Salesforce or Marketing Automation (MA) tool

Authentication

Requires an API key configured per site or system.

Rate Limits

Designed for near-real-time processing (less than 5 seconds end-to-end) and supports high-volume campaign bursts.

Request Body

  • name: Contact name
  • email: Contact email address (validated)
  • company: Company name
  • phone: Phone number (validated)
  • title: Job title
  • additional_fields: Additional form fields as key-value pairs
  • form_source: Source of form submission
  • enrichment_preferences: Enrichment preferences and configuration
  • output_preferences: Output preferences (return data vs push to external system)

Response Fields

  • success: Boolean indicating request success
  • status: Processing status (enriched, pushed, failed)
  • request_id: Unique request ID for tracking
  • processing_time_ms: Processing time in milliseconds
  • enriched_lead: Enriched lead data (if requested)
  • push_status: Status of push to external system (if applicable)
  • credits_consumed: Number of credits used
  • gdpr_safe: Whether enrichment was GDPR compliant
  • cached: Whether result was from cache

Features

  • Input Validation: Email and phone number validation
  • GDPR Compliance: Safe enrichment practices
  • Real-time Processing: Sub-5 second end-to-end processing
  • High Volume Support: Optimized for campaign bursts
  • Flexible Output: Return enriched data or push to external systems
  • Audit Trail: Complete logging for compliance

Credit Usage

Form submissions consume credits based on processing:

  • Basic Submission: 2 credits per form
  • With Enrichment: +3 credits for enrichment processing
  • With Push: +1 credit for external system push
Security
BearerAuth
Bodyapplication/jsonrequired
form_namestring(Form Name)required

Name of the form

form_payloadobject(Form Payload)required

Payload of the form

curl -i -X POST \
  https://api-gateway.agenthq.withlantern.com/v1/forms/submit \
  -H 'Authorization: Bearer <YOUR_ApiToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "form_name": "string",
    "form_payload": {}
  }'

Responses

Success Response

Bodyapplication/json
tenant_idinteger(Tenant Id)required

Tenant ID

submission_idstring, (uuid)(Submission Id)required

Submission ID

submitted_atstring, (date-time)(Submitted At)required

Submission timestamp

form_namestring(Form Name)required

Name of the form

form_payloadobject(Form Payload)required

Payload of the form

Response
{
  "tenant_id": 1,
  "submission_id": "123e4567-e89b-12d3-a456-426614174000",
  "submission_timestamp": "2024-01-15T10:30:00Z",
  "form_name": "Lead Generation Form",
  "form_payload": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "company": "Acme Corp",
    "phone": "+1-555-123-4567",
    "title": "VP Sales"
  }
}