Updating Form Name

Description: To update the details of a form, a HTTP PUT request is made to the URL with the form ID and session token.

Method: PUT

URI: /forms/form_id

URI Parameters

form_id: The ID of the form.

Parameters

name: The desired name of form.
private: Whether the form is private or not. If this property is not passed, the users default preference will be used.

Headers: Authorization: Third party based authorization header

Returns

Field	Type	Description
id	Integer	Unique ID of the form.
template_version_id	Integer	Unique ID of the template version of the template the form is made from.
agency_id	Integer	Unique ID of the form's agency.
user_id	Integer	Unique ID of the user that created the form.
name	String	Name of the form.
template	Boolean	Returns true if the form is a template.
finalised	Boolean	Returns true if the form is finalised.
private	Boolean	Returns true if the form is private.
created	Timestamp	Returns Unix timestamp of when form was created.
updated	Timestamp	Returns Unix timestamp of when form was updated.

Example

Request

  curl https://app-api.reiformslive.com.au/forms/1 \
  --request PUT \
  --header "content-type: application/json" \
  --header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
  --data '{
              "name":"New Form Name",
              "private":true
          }'

Response

  {
    "id": 1,
    "template_version_id": 1,
    "agency_id": 1,
    "user_id": 1,
    "name": "New Form Name",
    "template": false,
    "finalised": false,
    "private": null,
    "created": 1355095409,
    "updated": 1355097889
  }