Forms API

The forms API powers embedded forms. You usually let the Senderz form bundle call it, but you can call it directly.

POST /api/v1/forms/subscribe

Authenticated with the X-Sender-Tenant + X-API-Key headers. Requires the embedded_forms feature and passes the workspace’s origin allowlist.

Body

string

required

Subscriber email (max 320).

phone

string

Subscriber phone (max 40).

formId

string

A label for which form this came from (max 120). Client-supplied — not a security boundary.

fields

object

Extra field values. Native catalog keys route to their column; everything else lands in custom properties.

sourceUrl

string

The page URL the form was submitted from (max 2048).

Response

boolean

true on success.

contactId

string

The upserted contact’s UUID.

isNew

boolean

true if this created a new contact.

curl -X POST https://api.senderz.app/api/v1/forms/subscribe \
  -H "X-Sender-Tenant: your-workspace-slug" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -H "Origin: https://yourstore.com" \
  -d '{ "email": "dana@example.com", "fields": { "firstName": "Dana" } }'

{
  "success": true,
  "data": { "ok": true, "contactId": "b2f1c0de-…", "isNew": true }
}

Subscribing sets email consent to subscribed with source embedded_form, and enrols contact_created / list_joined flows.

This endpoint is rate limited to 10 requests per minute, and rejects submissions from origins not on your allowlist with 403. Configure the allowlist in Settings → Embedded Forms.

OTP API Validate connection

⌘I

Introduction

Ingest & transactional

Public API

Body

Response

​Subscribe

​Body

​Response

Subscribe

Body

Response