Portal Forms

Replace Form

Changed on

Replaces a custom form with the supplied fields and settings.

To remove a field, leave it out of the fields array; to rename a field, change its label (a field's name can't change once set).

The form's type can't be changed. Its name is fixed for developer_registration forms but can be changed for api_registration forms.

developer_registration forms must include the built-in full_name and email fields.

put/v3/portals/{portalId}/forms/{formId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/forms/{formId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

formIdstring uuid required
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the portal form.

Request body

OR

Example request

{
  "type": "developer_registration",
  "status": "published",
  "fields": [
    {
      "name": "full-name",
      "type": "content",
      "value": "## Tell us about your project"
    }
  ]
}

Response

A custom form belonging to a portal.

idstring uuid required

Contains a unique identifier used for this resource.

namestring required

A unique, URL-friendly identifier for the form (lowercase letters, digits, and hyphens). For developer_registration forms, this is always developer-registration. For api_registration forms, you choose the name when creating the form and can change it later.

type'developer_registration' | 'api_registration' required

The kind of form. Determines which fields are required and where developers see the form on the portal.

status'published' | 'unpublished' required

Whether the form is visible to developers on the portal. unpublished forms aren't shown to developers; for the developer_registration form, a default form is shown instead.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "name": "flights-api-registration",
  "type": "developer_registration",
  "status": "unpublished",
  "fields": [
    {
      "name": "full-name",
      "type": "content",
      "value": "## Tell us about your project",
      "built_in": true
    }
  ],
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status