SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
forms

Submit a response to a published form by slug.

Submit a response to a published form by slug.

POSThttps://staging.softsolz.uk/api/v1/services/forms/forms/{slug}/submit

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

slugstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Body Params

dataobject

Optional container for the field values keyed by field id. If omitted, top-level keys are treated as the field payload.

Response

Response Body

idinteger | nullCreated submission id (null when a honeypot trap silently drops it).
created_atstringSubmission timestamp.
success_messagestring | nullThe form's configured success message, or null.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.forms.submitForm('<slug>', {});
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 201

{
"data": {
"id": 0,
"created_at": "string",
"success_message": "string"
}
}