Skip to content
Elara One docs
Forms

Submit a form

POST
/v1/forms/{handle}

Authorization

tenantKey
headerX-Tenant-Key<token>

The public store key (pk_live_…). Required on every call.

Path Parameters

handle*string

Header Parameters

X-Client-IP?string

Optional. IP address of the shopper (one IPv4/IPv6, no port, no list). Honoured only together with a valid X-Tenant-Secret; ignored otherwise. Used for rate limits and recorded with form submissions.

X-Tenant-Secret?string

Optional here. Server secret of the store: server-to-server only, never from a browser. Enables X-Client-IP.

Idempotency-Key?string

Optional; recommended (a UUID made once per user action, reused only to retry that action). Only a success is stored (24 hours): the same key with the same body, URI and credentials (Authorization, X-Cart-Token, X-Chat-Token) replays it (Idempotent-Replayed: true); anything else under that key is 422 IDEMPOTENCY_KEY_REUSED. An error is never stored: after a 4xx or 5xx, retrying with the same key runs the request again.

X-Session-Id?string

Optional. The shopper's sid cookie value (8-128 of letters, digits, . _ : -). Decides the consent the lead rests on: whether the lead_submitted event keeps its session and visitor link, and whether the lead may be sent to ad platforms as a conversion. A lead has no basket, so this request is the only chance to read it. Read for this request only, compared as a SHA-256 hash, never stored raw. Send it on every write; a malformed value is ignored (never a 422), and leaving it out means "no choice known".

X-Visitor-Id?string

Optional. The vid cookie value, when the shopper has one. Decides the consent the lead rests on: whether the lead_submitted event keeps its session and visitor link, and whether the lead may be sent to ad platforms as a conversion. A lead has no basket, so this request is the only chance to read it. Read for this request only, compared as a SHA-256 hash, never stored raw. Send it on every write; a malformed value is ignored (never a 422), and leaving it out means "no choice known".

Response Body

Success.

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.elaraone.app/api/v1/forms/string' \  -H 'X-Tenant-Key: pk_live_…' \  -H 'X-Tenant-Secret: your-server-secret'
Example Response
{  "data": {    "result_id": 0  }}