TrieOH
InformdAPIFields

Bulk-edit a step's fields

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.

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

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.

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.

[index: integer]?

Entry for bulk field editing. Mirrors models.UpdateFieldRequest.

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PUT "https://example.com/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps/497f6eca-6276-4993-bfeb-53cbbbba6f08/fields" \  -H "Content-Type: application/json" \  -d '[    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "key": "string",      "title": "string",      "position_hint": 1,      "required": true,      "type": "string"    }  ]'
Empty
{
  "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"
}

Create a field POST

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.

Get a field's select configuration GET

Fetches the select configuration (behaviour, value type, options) of a `select` field. The actor must be a member of the form.