---
title: "Update subscription form"
method: PUT
path: "/subscription-forms/{subscriptionFormId}"
tags: ["Subscription Forms"]
---

# Update subscription form

`PUT /subscription-forms/{subscriptionFormId}`

Update the existing subscription form. The form content is defined using Gravitee Markdown (GMD)
syntax with form components.

Note: This operation does NOT change the enabled state. Use _enable/_disable endpoints for that.

User must have the ENVIRONMENT_SETTINGS[UPDATE] permission.

## Path parameters

- `subscriptionFormId` string, uuid, required

## Request body

- UpdateSubscriptionForm — Payload for updating a subscription form
  - `gmdContent` string, required — Gravitee Markdown (GMD) content defining the form. Supports form components like gmd-input, gmd-textarea, gmd-select, gmd-checkbox, gmd-radio. Content is validated for security - malicious HTML/scripts will be rejected.

## Response `200`

Subscription form saved successfully

- SubscriptionForm — Subscription form definition used by API consumers when subscribing to APIs
  - `id` string, uuid, required — Unique identifier of the subscription form
  - `gmdContent` string, required — Gravitee Markdown (GMD) content defining the form. Supports form components like gmd-input, gmd-textarea, gmd-select, gmd-checkbox, gmd-radio.
  - `enabled` boolean, required — Whether the form is enabled and visible to API consumers in the Developer Portal
  - `resolvedOptions` object — Resolved option lists for fields that use EL expressions. Keys are field keys; values are the effective option lists (fallback values when no API context is available). Present only when at least one field has dynamic options.

## Other responses

- `400` — Invalid or unsafe GMD content
- `404` — No subscription form exists with this ID
- `default` — Generic error response

---

[API](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-environments.md) · [All operations](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-environments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gravitee-io/gravitee-io-apim-management-api-environments/versions/37e8cbe5f769/schema)