API ReferenceSubmissions
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication. Pass your ioZen API key as a Bearer token in the Authorization header.
In: header
Path Parameters
id*string
Intake bot ID
Request Body
application/json
Submission field values and options
data*object
Field values keyed by field name from the intake bot schema. Values may be string, number, boolean, string[], or null. Select an example from the dropdown in the code panel to pre-fill realistic values.
status?string
Submission status — COMPLETED triggers webhook events
Default
"COMPLETED"Value in
"IN_PROGRESS" | "COMPLETED"is_test?boolean
Mark as test submission (excluded from analytics)
Default
falseResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
A simple submission with common text fields.
curl -X POST "https://app.iozen.ai/api/v1/intake-bots/cm7abc12x0001yz9k8mno3pqr/submissions" \ -H "Content-Type: application/json" \ -d '{ "data": { "full_name": "Jane Doe", "email": "jane@example.com", "company": "Acme Corp" }, "status": "COMPLETED", "is_test": false }'{
"success": true,
"data": {
"submission": {
"id": "string",
"status": "string",
"created_at": "string"
}
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "Validation failed",
"details": {}
}
}{
"success": false,
"error": {
"code": "authentication_required",
"message": "Missing or invalid API key",
"details": {}
}
}{
"success": false,
"error": {
"code": "insufficient_scopes",
"message": "API key lacks required scopes for this endpoint",
"details": {}
}
}{
"success": false,
"error": {
"code": "resource_not_found",
"message": "Resource not found",
"details": {}
}
}{
"success": false,
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded",
"details": {}
}
}{
"success": false,
"error": {
"code": "internal_error",
"message": "An internal error occurred",
"details": {}
}
}