Update Form
PUT {{apiPath}}/environments/{{envID}}/forms/{{formID}}
The PUT /environments/{environmentId}/forms/{{formID}} operation updates the forms resource in the environment identified by its ID in the request URL.
See Forms for complete descriptions.
| Property | Type | Required? |
|---|---|---|
created | Date | N/A |
category | String | Required |
cols | Integer | Optional |
components | Object | Required |
description | String | Optional |
environment.id | String | N/A |
fieldTypes | Object | Optional |
id | String | N/A |
languageBundle | Object | Optional |
markOptional | Boolean | Required |
markRequired | Boolean | Required |
modified | Date | N/A |
name | String | Required |
translationMethod | String | Optional |
Request Body
{"name"=>"Custom-Form_Updated_{{$timestamp}}", "description"=>"Test Description - updated via UPDATE Custom Form request", "category"=>"CUSTOM", "components"=>{"fields"=>[{"type"=>"TEXT", "position"=>{"row"=>0, "col"=>0}, "key"=>"field", "label"=>"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"},{\"type\":\"i18n\",\"key\":\"fields.user.email.label\",\"defaultTranslation\":\"Email Address\",\"inline\":true,\"children\":[{\"text\":\"\"}]},{\"text\":\"\"}]}]", "required"=>true, "validation"=>{"type"=>"NONE", "regex"=>"", "errorMessage"=>""}, "attributeDisabled"=>false}, {"type"=>"SUBMIT_BUTTON", "position"=>{"row"=>1, "col"=>0}, "label"=>"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"},{\"type\":\"i18n\",\"key\":\"button.text\",\"defaultTranslation\":\"Submit\",\"inline\":true,\"children\":[{\"text\":\"\"}]},{\"text\":\"\"}]}]"}]}, "cols"=>4, "markOptional"=>true, "markRequired"=>false, "translationMethod"=>"TRANSLATE", "fieldTypes"=>["SUBMIT_BUTTON", "TEXT"], "languageBundle"=>{"fields.user.email.label"=>"Email Address", "button.text"=>"Submit"}}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/forms/05e406b0-156a-45d4-ab5f-6cc612057643"}},"id":"05e406b0-156a-45d4-ab5f-6cc612057643","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Custom-Form_Updated_1723747832","description":"Test Description - updated via UPDATE Custom Form request","category":"CUSTOM","components":{"fields":[{"type":"TEXT","position":{"row":0,"col":0},"key":"field","label":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"},{\"type\":\"i18n\",\"key\":\"fields.user.email.label\",\"defaultTranslation\":\"Email Address\",\"inline\":true,\"children\":[{\"text\":\"\"}]},{\"text\":\"\"}]}]","required":true,"validation":{"type":"NONE","regex":"","errorMessage":""},"otherOptionEnabled":false,"otherOptionAttributeDisabled":false,"attributeDisabled":false},{"type":"SUBMIT_BUTTON","position":{"row":1,"col":0},"label":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"},{\"type\":\"i18n\",\"key\":\"button.text\",\"defaultTranslation\":\"Submit\",\"inline\":true,\"children\":[{\"text\":\"\"}]},{\"text\":\"\"}]}]"}]},"cols":4,"markOptional":true,"markRequired":false,"translationMethod":"TRANSLATE","fieldTypes":["TEXT","SUBMIT_BUTTON"],"languageBundle":{"fields.user.email.label":"Email Address","button.text":"Submit"},"created":"2024-08-15T18:49:55.948Z","modified":"2024-08-15T18:50:32.257Z"}