Web2Lead

class ab.api.endpoints.web2lead.Web2LeadEndpoint(client)[source]

Web-to-lead capture (ABC API).

Parameters:: client (HttpClient)

GET /Web2Lead/get.

Parameters:: params (Web2LeadGetParams | dict) – Lead query parameters (29 optional string fields). Accepts a Web2LeadGetParams instance or a dict with snake_case or PascalCase keys.
Return type:: Web2LeadResponse

Params model: Web2LeadGetParams

Docs: https://ab-sdk.readthedocs.io/en/latest/api/web2lead/get.html Query params: Web2LeadGetParams Response model: Web2LeadResponse

post(*, data)[source]

POST /Web2Lead/post.

Parameters:: data (Web2LeadRequest | dict) – Web-to-lead submission payload. Accepts a Web2LeadRequest instance or a dict.
Return type:: Web2LeadResponse

Request model: Web2LeadRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/web2lead/post.html Request model: Web2LeadRequest Response model: Web2LeadResponse

Uses the ABC API surface (requires access_key in configuration).

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.web2lead.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

Methods

get

GET /Web2Lead (ABC) — Get Web2Lead configuration.

Returns: Web2LeadResponse

from ab import ABConnectAPI

api = ABConnectAPI(env="staging")
config = api.web2lead.get()

post

POST /Web2Lead (ABC) — Submit a Web2Lead form.

api.web2lead.post({
    "companyCode": "14004OH",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
})