Portal Forms

Creates a custom form for a portal.

  • developer_registration forms appear in the portal's developer signup flow
  • api_registration forms are shown to developers when they request access to a specific API.

Requirements:

  • Every form's fields array must include exactly one submit field.
  • developer_registration forms must also include the built-in full_name and email fields.
post/v3/portals/{portalId}/forms

Request

  • Base URL
    https://global.api.konghq.com
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Path parameters

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

The Portal identifier

Request body

OR

Example request

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

Response

A custom form belonging to a portal.

OR

Example response

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

Changes