GRgravitee-io
Subscription Forms

Update subscription form

Changed on

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.

put/subscription-forms/{subscriptionFormId}

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/subscription-forms/{subscriptionFormId}
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Path parameters

subscriptionFormIdstring uuid required

The unique ID of the subscription form

Request body

gmdContentstring 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.

Example request

{
  "gmdContent": "# Subscription Information\n\n<gmd-input name=\"consumer_company_name\" label=\"Company Name\" required=\"true\"/>\n<gmd-textarea name=\"consumer_use_case\" label=\"Use Case\" required=\"true\"/>\n"
}

Response

Subscription form saved successfully

idstring uuid required

Unique identifier of the subscription form

gmdContentstring required

Gravitee Markdown (GMD) content defining the form. Supports form components like gmd-input, gmd-textarea, gmd-select, gmd-checkbox, gmd-radio.

enabledboolean required

Whether the form is enabled and visible to API consumers in the Developer Portal

resolvedOptionsobject

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.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "gmdContent": "# Subscription Information\n\n<gmd-input name=\"consumer_company_name\" label=\"Company Name\" required=\"true\"/>\n<gmd-textarea name=\"consumer_use_case\" label=\"Use Case\" required=\"true\"/>\n"
}

Changes