Portal Forms
Replace Form
Changed onReplaces 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 URLhttps://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
formIdstring uuid required
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the portal form.
Request body
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.
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
- info
endpoint added
- info