Update Record Custom Forms

Updates the custom form for the specified record.

Resource Information

Scope	records Deprecated scope name: update_record_customforms
App Type	All
Authorization Type	Access token
URI	/v4/records/{recordId}/customForms?lang={lang}
HTTP Method	PUT
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
lang	String	No	�	Indicates the language applied.	7.3.2
<customType>	string	Yes	�	A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No".	7.3.2
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2

Example

Sample Request Body

[
  {
    "id": "SR_STANDARD-COMPLAINT.cINFORMATION",
    "Source of Complaint": "Citizen",
    "Location": "At garage",
    "Type of Submittal": "Online Service Request",
    "Notify Complainant": "No"
  }
]

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.code	string	A code identifying an associated item	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isSuccess	boolean	Indicates whether or not the operation on the item is successful.	7.3.2
result.message	string	A text message related to the operation.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "SR_STANDARD-COMPLAINT.cINFORMATION"
    }
  ]
}