PUT v1/forms/{id}

Use this method to update form level values like form name, description etc. This method will not update form elements in any way.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Form unique identifier to be updated.

 string

Required

Body Parameters

Form values to be updated.

DynamicForm
NameDescriptionTypeAdditional information
id

Form unique identifier.

 string

None.
type

Form Type (Used by MDU solutions only)

 string

None.
name

Form Name

 string

None.
description

Form Description

 string

None.
items

Form Items

 Collection of FormElement

None.
emailActionSettings

Use this property to modify action settings. Action settings can not be deleted or added, only updated as they are pointers to underlaying form associated actions and not actual settings of the element themselves. When editing a Submit Button Form element, the settings related to email come from this collection of settings.

 Collection of EntityTemplateActionSetting

None.

Request Formats

application/json, text/json

Sample: 
{
  "id": "sample string 1",
  "type": "sample string 2",
  "name": "sample string 3",
  "description": "sample string 4",
  "items": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "label": "sample string 3",
      "formUUID": "sample string 4",
      "help": "sample string 5",
      "required": true,
      "type": {
        "id": "sample string 1",
        "type": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4"
      },
      "order": 7,
      "prompt": "sample string 8",
      "textType": 1,
      "minLength": 1,
      "maxLength": 1,
      "preFill": true,
      "preFillTag": "sample string 9",
      "width": 1,
      "height": 1,
      "alignment": "sample string 10",
      "defaultOption": "sample string 11",
      "minuteInterval": 1,
      "defaultDate": "sample string 12",
      "minDate": "sample string 13",
      "maxDate": "sample string 14",
      "defaultCheck": true,
      "errorColor": "sample string 15",
      "choices": [
        {
          "id": "sample string 1",
          "name": "sample string 3",
          "internalName": "sample string 4",
          "order": 1
        },
        {
          "id": "sample string 1",
          "name": "sample string 3",
          "internalName": "sample string 4",
          "order": 1
        }
      ]
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "label": "sample string 3",
      "formUUID": "sample string 4",
      "help": "sample string 5",
      "required": true,
      "type": {
        "id": "sample string 1",
        "type": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4"
      },
      "order": 7,
      "prompt": "sample string 8",
      "textType": 1,
      "minLength": 1,
      "maxLength": 1,
      "preFill": true,
      "preFillTag": "sample string 9",
      "width": 1,
      "height": 1,
      "alignment": "sample string 10",
      "defaultOption": "sample string 11",
      "minuteInterval": 1,
      "defaultDate": "sample string 12",
      "minDate": "sample string 13",
      "maxDate": "sample string 14",
      "defaultCheck": true,
      "errorColor": "sample string 15",
      "choices": [
        {
          "id": "sample string 1",
          "name": "sample string 3",
          "internalName": "sample string 4",
          "order": 1
        },
        {
          "id": "sample string 1",
          "name": "sample string 3",
          "internalName": "sample string 4",
          "order": 1
        }
      ]
    }
  ],
  "emailActionSettings": [
    {
      "id": "sample string 1",
      "name": "sample string 3",
      "value": "sample string 4"
    },
    {
      "id": "sample string 1",
      "name": "sample string 3",
      "value": "sample string 4"
    }
  ]
}

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.