{"__v":3,"_id":"543484820ef9c0080016513a","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-08T00:25:38.586Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"examples":{"codes":[]},"method":"post","results":{"codes":[{"name":"Success","code":"{\n  \"id\" : \"12345\",\n}","language":"json","status":201},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A form id was not supplied\"\n}","language":"json","status":400,"name":"Form ID not specified"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid form id was not supplied\"\n}","language":"json","status":404,"name":"Form not found"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"The action was forbidden by form permissions\"\n}","language":"json","status":403,"name":"Forbidden action"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid field type was not supplied\"\n}","language":"json","status":400,"name":"Invalid field type argument"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"Sorry, your account only allows you a maxiumum of <max fields> fields per form. Please upgrade your account if you want to create more fields for the form, or delete one of the existing fields.\"\n}","language":"json","status":400,"name":"Maximum field limit reached"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"Could not update the field order: Error specific message\"\n}","language":"json","status":500,"name":"Error updating field"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"Could not save the field: Error specific message\"\n}","language":"json","status":500,"name":"Error saving field"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"Could not update the form: Error specific message\"\n}","language":"json","status":500,"name":"Error updating form"}]},"settings":"","try":false,"auth":"required","params":[{"_id":"543484820ef9c00800165142","ref":"","in":"path","required":true,"desc":"Form ID","default":"","type":"int","name":"id"},{"_id":"543484820ef9c00800165141","ref":"","in":"body","required":true,"desc":"Field type","default":"","type":"string","name":"field_type"},{"_id":"543484820ef9c00800165140","ref":"","in":"body","required":true,"desc":"Field label. This is not required for Description Area or Embed Code fields.","default":"","type":"string","name":"label"},{"_id":"543484820ef9c0080016513f","ref":"","in":"body","required":false,"desc":"Flag to show or hide the label","default":"0","type":"boolean","name":"hide_label"},{"_id":"543484820ef9c0080016513e","ref":"","in":"body","required":false,"desc":"Field description (shown below field)","default":"","type":"string","name":"description"},{"_id":"543484820ef9c0080016513d","ref":"","in":"body","required":false,"desc":"Flag to show the description in a callout box","default":"0","type":"boolean","name":"description_callout"},{"_id":"543484820ef9c0080016513c","ref":"","in":"body","required":false,"desc":"Initial value for the field","default":"","type":"string","name":"default_value"},{"_id":"543484820ef9c0080016513b","ref":"","in":"body","required":false,"desc":"Array of option labels","default":"","type":"array_mixed","name":"options"},{"_id":"543487ab0ef9c00800165177","ref":"","in":"body","required":false,"desc":"Array of option values","default":"","type":"array_mixed","name":"options_values"},{"_id":"543487ab0ef9c00800165176","ref":"","in":"body","required":false,"desc":"Flag to mark field as required","default":"0","type":"boolean","name":"required"},{"_id":"543487ab0ef9c00800165175","ref":"","in":"body","required":false,"desc":"Flag to not allow the field to be changed","default":"0","type":"boolean","name":"readonly"},{"_id":"543487ab0ef9c00800165174","ref":"","in":"body","required":false,"desc":"Flag to hide the field","default":"0","type":"boolean","name":"hidden"},{"_id":"543487ab0ef9c00800165173","ref":"","in":"body","required":false,"desc":"Flag to mark field as requiring a unique value","default":"0","type":"boolean","name":"uniq"},{"_id":"543487ab0ef9c00800165172","ref":"","in":"body","required":false,"desc":"Number of columns this field should span","default":"1","type":"int","name":"colspan"},{"_id":"543487ab0ef9c00800165171","ref":"","in":"body","required":false,"desc":"Sort index for the field (Starts at 0)","default":"Last field sort index","type":"int","name":"sort"},{"_id":"543487ab0ef9c00800165170","ref":"","in":"body","required":false,"desc":"Field attributes. See [Field Attributes](#field-attributes) section.","default":"","type":"object","name":"attributes"},{"_id":"582df3d9e046d30f00d6b4b2","ref":"","in":"body","required":false,"desc":"Field logic. See [Field Logic](#field-logic) section below.","default":"","type":"object","name":"logic"},{"_id":"582df9e436ad1c0f00d4fdcc","ref":"","in":"body","required":false,"desc":"Default value calculation. See [Field Calculation](#field-calculation) section below.","default":"","type":"string","name":"calculation"}],"url":"/v2/form/:id/field.json"},"isReference":false,"order":15,"body":"Create a new field for the specified form\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /api/v2/form/12345/field.json HTTP/1.1\\nHost: www.formstack.com\\nAuthorization: Bearer [[app:oauth_token]]\\nAccept: application/json\\nContent-Type: application/json\\n\\n{\\\"field_type\\\":\\\"name\\\",\\\"label\\\":\\\"Name\\\",\\\"attributes\\\":{\\\"show_prefix\\\":\\\"1\\\",\\\"show_middle\\\":\\\"1\\\"}}\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -X POST -i -H \\\"Accept: application/json\\\" -H \\\"Content-Type: application/json\\\" -H \\\"Authorization: Bearer [[app:oauth_token]]\\\" -d '{\\\"field_type\\\":\\\"name\\\",\\\"label\\\":\\\"Name\\\",\\\"attributes\\\":{\\\"show_prefix\\\":\\\"1\\\",\\\"show_middle\\\":\\\"1\\\"}}' https://formstack.com/api/v2/form/12345/field.json\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Field Attributes\"\n}\n[/block]\nSee [Field Types](doc:field-types) for more information about the attributes available to set in the `attributes` property.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Field Logic\"\n}\n[/block]\nSee [Field Logic](doc:field-logic) for more information about the `logic` property.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Field Calculation\"\n}\n[/block]\nSee [Field Calculations](doc:field-calculations) for more information about the `calculation` property.","excerpt":"Create a new field for the specified form","slug":"form-id-field-post","type":"endpoint","title":"/form/:id/field"}

post/form/:id/field

Create a new field for the specified form

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Form ID

Body Params

field_type:
required
string
Field type
label:
required
string
Field label. This is not required for Description Area or Embed Code fields.
hide_label:
boolean0
Flag to show or hide the label
description:
string
Field description (shown below field)
description_callout:
boolean0
Flag to show the description in a callout box
default_value:
string
Initial value for the field
options:
array of mixed
Array of option labels
options_values:
array of mixed
Array of option values
required:
boolean0
Flag to mark field as required
readonly:
boolean0
Flag to not allow the field to be changed
hidden:
boolean0
Flag to hide the field
uniq:
boolean0
Flag to mark field as requiring a unique value
colspan:
integer1
Number of columns this field should span
sort:
integerLast field sort index
Sort index for the field (Starts at 0)
attributes:
object
Field attributes. See [Field Attributes](#field-attributes) section.
logic:
object
Field logic. See [Field Logic](#field-logic) section below.
calculation:
string
Default value calculation. See [Field Calculation](#field-calculation) section below.

Result Format


Documentation

Create a new field for the specified form [block:code] { "codes": [ { "code": "POST /api/v2/form/12345/field.json HTTP/1.1\nHost: www.formstack.com\nAuthorization: Bearer [[app:oauth_token]]\nAccept: application/json\nContent-Type: application/json\n\n{\"field_type\":\"name\",\"label\":\"Name\",\"attributes\":{\"show_prefix\":\"1\",\"show_middle\":\"1\"}}", "language": "http" }, { "code": "curl -X POST -i -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Authorization: Bearer [[app:oauth_token]]\" -d '{\"field_type\":\"name\",\"label\":\"Name\",\"attributes\":{\"show_prefix\":\"1\",\"show_middle\":\"1\"}}' https://formstack.com/api/v2/form/12345/field.json", "language": "shell" } ] } [/block] [block:api-header] { "title": "Field Attributes" } [/block] See [Field Types](doc:field-types) for more information about the attributes available to set in the `attributes` property. [block:api-header] { "type": "basic", "title": "Field Logic" } [/block] See [Field Logic](doc:field-logic) for more information about the `logic` property. [block:api-header] { "type": "basic", "title": "Field Calculation" } [/block] See [Field Calculations](doc:field-calculations) for more information about the `calculation` property.

User Information

Try It Out

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