TrieOH
InformdAPISteps

Create a step

Adds a step (section) to the form. The actor must be an admin or owner of the form.

POST/forms/{form_id}/steps

Adds a step (section) to the form. The actor must be an admin or owner of the form.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

form_id*string

Form ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for step creation. Mirrors models.CreateStepRequest.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps" \  -H "Content-Type: application/json" \  -d '{    "title": "Personal Info",    "description": "Tell us about yourself.",    "position_hint": 1  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
  "title": "string",
  "description": "string",
  "position_hint": 1
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 400,
  "title": "Validation Failed"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 403,
  "title": "Insufficient Role"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 404,
  "title": "Not Found"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}

List a form's steps GET

Lists the steps (sections) of a form in positional order. The actor must be a member of the form.

Bulk-edit a form's steps PUT

Replaces the full step list of the form in one call — each entry carries its `id` (existing steps are updated) plus title, description, and position hint. The actor must be an admin or owner of the form.