{"__v":3,"_id":"543478fb5b10711400c6c29f","category":{"__v":30,"_id":"5434918d0ef9c008001651ff","pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"project":"543469460ef9c00800164f0e","version":"54346a2a0ef9c00800164f28","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-08T01:21:17.804Z","from_sync":false,"order":1,"slug":"rest-api","title":"REST API"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"543469460ef9c00800164f0e","user":"543469060ef9c00800164f01","version":{"__v":7,"_id":"54346a2a0ef9c00800164f28","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","createdAt":"2014-10-07T22:33:14.982Z","releaseDate":"2014-10-07T22:33:14.982Z","categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-07T23:36:27.245Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"success\": \"1\",\n  \"id\": \"1\"\n}","name":"Success"},{"status":400,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"A form id was not supplied\"\n}","name":"Form ID not specified"},{"status":404,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid form id was not supplied\"\n}","name":"Form not found"},{"status":403,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"The action was forbidden by form permissions\"\n}","name":"Forbidden action"},{"status":500,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"Could not update form: Error specific message\"\n}","name":"Error updating form"}]},"settings":"","try":false,"auth":"required","params":[{"_id":"543479f75b10711400c6c2be","ref":"","in":"path","required":true,"desc":"Form ID","default":"","type":"int","name":"id"},{"_id":"543479f75b10711400c6c2bd","ref":"","in":"body","required":false,"desc":"The form name","default":"","type":"string","name":"name"},{"_id":"543479f75b10711400c6c2bc","ref":"","in":"body","required":false,"desc":"Flag to disable or enable submissions to be saved in our database","default":"1","type":"boolean","name":"db"},{"_id":"543479f75b10711400c6c2bb","ref":"","in":"body","required":false,"desc":"Template ID for the template you want to use","default":"","type":"string","name":"template"},{"_id":"543479f75b10711400c6c2ba","ref":"","in":"body","required":false,"desc":"Number (1-4) of columns the form layout will have","default":"","type":"int","name":"num_columns"},{"_id":"543479f75b10711400c6c2b9","ref":"","in":"body","required":false,"desc":"Sets the default field label position. Possible values are: \"top\" or \"left\"","default":"","type":"string","name":"label_position"},{"_id":"543479f75b10711400c6c2b8","ref":"","in":"body","required":false,"desc":"Sets the submit button title","default":"","type":"string","name":"submit_button_title"},{"_id":"543479f75b10711400c6c2b7","ref":"","in":"body","required":false,"desc":"Sets a password for the form","default":"","type":"string","name":"password"},{"_id":"543479f75b10711400c6c2b6","ref":"","in":"body","required":false,"desc":"Flag to disable or enable SSL (only available on accounts that have security features)","default":"0","type":"boolean","name":"use_ssl"},{"_id":"543479f75b10711400c6c2b5","ref":"","in":"body","required":false,"desc":"Sets the timezone for the form","default":"","type":"string","name":"timezone"},{"_id":"54347b2d5b10711400c6c2e7","ref":"","in":"body","required":false,"desc":"Sets the language for the form - use ISO 639-1 language codes","default":"","type":"string","name":"language"},{"_id":"54347b2d5b10711400c6c2e6","ref":"","in":"body","required":false,"desc":"Flag to make the form active/inactive","default":"1","type":"boolean","name":"active"},{"_id":"54347b2d5b10711400c6c2e5","ref":"","in":"body","required":false,"desc":"The message to show when the form is inactive","default":"","type":"string","name":"disabled_message"}],"url":"/v2/form/:id.json"},"isReference":false,"order":9,"body":"Update the details of the specified form\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT /api/v2/form/12345.json HTTP/1.1\\nHost: www.formstack.com\\nAuthorization: Bearer [[app:oauth_token]]\\nAccept: application/json\\nContent-Type: application/json\\n\\nname=Test%20Form&submit_button_title=Save%20Form&use_ssl=1\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -X PUT -i -H \\\"Accept: application/json\\\" -H \\\"Content-Type: application/json\\\" -H \\\"Authorization: Bearer [[app:oauth_token]]\\\" -d \\\"name=Test%20Form&submit_button_title=Save%20Form&use_ssl=1\\\" https://www.formstack.com/api/v2/form/12345.json\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"Update the details of the specified form","slug":"form-id-put","type":"put","title":"/form/:id"}

put/form/:id

Update the details of the specified form

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Form ID

Body Params

name:
string
The form name
db:
boolean1
Flag to disable or enable submissions to be saved in our database
template:
string
Template ID for the template you want to use
num_columns:
integer
Number (1-4) of columns the form layout will have
label_position:
string
Sets the default field label position. Possible values are: "top" or "left"
submit_button_title:
string
Sets the submit button title
password:
string
Sets a password for the form
use_ssl:
boolean0
Flag to disable or enable SSL (only available on accounts that have security features)
timezone:
string
Sets the timezone for the form
language:
string
Sets the language for the form - use ISO 639-1 language codes
active:
boolean1
Flag to make the form active/inactive
disabled_message:
string
The message to show when the form is inactive

Result Format


Documentation

Update the details of the specified form [block:code] { "codes": [ { "code": "PUT /api/v2/form/12345.json HTTP/1.1\nHost: www.formstack.com\nAuthorization: Bearer [[app:oauth_token]]\nAccept: application/json\nContent-Type: application/json\n\nname=Test%20Form&submit_button_title=Save%20Form&use_ssl=1", "language": "http" }, { "code": "curl -X PUT -i -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Authorization: Bearer [[app:oauth_token]]\" -d \"name=Test%20Form&submit_button_title=Save%20Form&use_ssl=1\" https://www.formstack.com/api/v2/form/12345.json", "language": "shell" } ] } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}