TrieOH
InformdAPIFields

Create a field

Adds a field (question) to a step. When `type` is `select`, `select_config` is required. The actor must be an admin or owner of the form.

POST/forms/{form_id}/steps/{step_id}/fields

Adds a field (question) to a step. When type is select, select_config is required. 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.

step_id*string

Step ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for field creation. Mirrors models.CreateFieldRequest.

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/fields" \  -H "Content-Type: application/json" \  -d '{    "key": "full_name",    "title": "Full name",    "description": "As on your ID.",    "position_hint": 1,    "required": true,    "type": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "step_id": "5cb19d54-1551-4ee7-a292-ee3ee4dcef77",
  "key": "string",
  "title": "string",
  "description": "string",
  "position_hint": 1,
  "required": true,
  "type": "string",
  "placeholder": {},
  "default_value": {},
  "config": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "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 step's fields GET

Lists the fields (questions) of a step in positional order. The actor must be a member of the form.

Bulk-edit a step's fields PUT

Replaces the full field list of a step in one call — each entry carries its `id` (existing fields are updated) plus all field attributes. The actor must be an admin or owner of the form.