Forms

Create an option preset

POST/option-presets
forms:writecreate_option_preset

Creates a preset and returns it with a Location. name (at most 255 characters) and items (a list of strings, at least one) are required. dry_run shows the result without saving it. Emits option_preset.created and sends no email. DELETE /option-presets/{id} undoes it while no field uses it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · OptionPresetCreate

  • namestringRequired#

    The preset's display name.

  • descriptionstring | null#

    What the preset is for.

  • itemsstring[]Required#

    The options, in order.

{
  "name": "Investor types",
  "description": "Reusable list of investor classifications.",
  "items": [
    "Retail",
    "Professional",
    "Institutional"
  ]
}

Responses

201

The preset was created.

OptionPreset
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "description": "string",
    "items": [
      "string"
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/option-presets\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Investor types",
  "description": "Reusable list of investor classifications.",
  "items": [
    "Retail",
    "Professional",
    "Institutional"
  ]
}'