Skip to content

Submit a public form

POST
/public/forms/{formSlug}/submit
curl --request POST \
--url 'https://kynectlocal-production.up.railway.app/v1/public/forms/example/submit?brandId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
formSlug
required
string
brandId
required
string format: uuid

Brand scope for the form

Success

Media type application/json
object
data
required
object
leadId
required

Created lead identifier

string format: uuid
success
required

Always true on success

boolean
Example
{
"data": {
"success": true
}
}

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}