{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/checks","auth":"required","method":"put","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"checklist_id\": 5025,\n    \"checklist_name\": \"checklist NL\",\n    \"checklist_external_id\": 1000011,\n    \"section\": {\n        \"id\": 30976,\n        \"name\": \"section EN 2\",\n        \"external_id\": 10000002,\n        \"position\": 0,\n        \"checks\": [\n            {\n                \"id\": 207359,\n                \"name\": \"check NL\",\n                \"external_id\": null,\n                \"position\": 2,\n                \"remarks\": []\n            },\n            {\n                \"id\": 207360,\n                \"name\": \"check NL\",\n                \"external_id\": 5000000,\n                \"position\": 3,\n                \"remarks\": []\n            }\n        ]\n    }\n}","name":""}]},"settings":"","params":[{"name":"auth_token","type":"string","default":"","desc":"Your authentication token.","required":true,"in":"body","ref":"","_id":"5a8174e6da40f30031799dd6"},{"name":"check.name_en","type":"string","default":"","desc":"Name in English. You must fill in at least one translated field for the check name.","required":true,"in":"body","ref":"","_id":"5a8174e6da40f30031799dd5"},{"name":"check.name_nl","type":"string","default":"","desc":"Name in Dutch.","required":false,"in":"body","ref":"","_id":"5a8174e6da40f30031799dd4"},{"name":"check.name_fr","type":"string","default":"","desc":"Name in French.","required":false,"in":"body","ref":"","_id":"5a8174e6da40f30031799dd3"},{"name":"checklist_id","type":"int","default":"","desc":"The checklist_id to which you want to add a new check","required":false,"in":"body","ref":"","_id":"5a8174e6da40f30031799dd9"},{"name":"section_id","type":"int","default":"","desc":"The section_id to which belongs the check","required":false,"in":"body","ref":"","_id":"5a8174e6da40f30031799dd8"},{"name":"id","type":"int","default":"","desc":"The id of the check you want to update","required":false,"in":"body","ref":"","_id":"5a8174e6da40f30031799dd7"},{"name":"checklist_external_id","type":"int","default":"","desc":"The external ID of the checklist to which belongs the check","required":false,"in":"body","ref":"","_id":"5a8af27913cba9004f29963d"},{"name":"section_external_id","type":"int","default":"","desc":"The external ID of the checklist to which belongs the check","required":false,"in":"body","ref":"","_id":"5a8af27913cba9004f29963c"},{"name":"check.external_id","type":"int","default":"","desc":"The external ID of the check","required":false,"in":"body","ref":"","_id":"5a8af27913cba9004f29963b"}]},"next":{"description":"","pages":[]},"title":"Update a check","type":"endpoint","slug":"update-a-check","excerpt":"This part of the API lets you manage your checklists","body":"","updates":[],"order":34,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a81730cda40f30031799dc9","project":"54870ea47810260b001c36ab","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54870ea57810260b001c36af","5487116f7810260b001c36b5","548711797810260b001c36b6","548711807810260b001c36b7","548713127810260b001c36bd","548713247810260b001c36be","548713aa7810260b001c36c0","548713c2f907080b00fc49d5","548713eef907080b00fc49d9","54871a0db3441a1f00f20d78","54871b15b3441a1f00f20d7e","54871cbeb3441a1f00f20d87","548817fac178b40b00aa2eec","558a6dd975eaf50d004e4bf5","558a6e37dbe5b63700f8d1fe","56795d8c07bf6a0d0083ee9e","583e9d764ced340f00b05a5c","5d1f3f70b4648901728803b7","5d22f7db4c9e14005111e34f","5d22fa62a541770012a07464"],"_id":"54870ea57810260b001c36ae","createdAt":"2014-12-09T15:00:53.237Z","project":"54870ea47810260b001c36ab","releaseDate":"2014-12-09T15:00:53.237Z","__v":20},"category":{"sync":{"isSync":false,"url":""},"pages":["558a6e098d30cb2300873e1a","558a6e88dbe5b63700f8d201","558a6e9275eaf50d004e4bfa","558a6e9a8d30cb2300873e1c","558a79f2dbe5b63700f8d23f","5592abfb6bf22f170075b823","55a65e4580c8a30d00b32618","55ba22f804775a2f006280aa","55ba2648b3612925009d66f0","56045138e416560d00fa6484","560452e4e5102a0d0070f965","560455090c78b00d0039b18b","56176873a410c90d00c612aa","56176a014d9e4a17002a0e05","5628d38e0653060d00a2f7d9","5628d5d748742a0d0047456d","56a669cffb12a40d006c4826"],"title":"API","slug":"api","order":5,"from_sync":false,"reference":true,"_id":"558a6dd975eaf50d004e4bf5","version":"54870ea57810260b001c36ae","__v":17,"createdAt":"2015-06-24T08:44:09.019Z","project":"54870ea47810260b001c36ab"},"user":"54870d54f907080b00fc49cd","createdAt":"2018-02-12T10:57:16.774Z","githubsync":"","__v":6,"parentDoc":null,"updatedAt":"2019-07-08T08:09:00.208Z"}

putUpdate a check

This part of the API lets you manage your checklists

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

auth_token:
required
string
Your authentication token.
check.name_en:
required
string
Name in English. You must fill in at least one translated field for the check name.
check.name_nl:
string
Name in Dutch.
check.name_fr:
string
Name in French.
checklist_id:
integer
The checklist_id to which you want to add a new check
section_id:
integer
The section_id to which belongs the check
id:
integer
The id of the check you want to update
checklist_external_id:
integer
The external ID of the checklist to which belongs the check
section_external_id:
integer
The external ID of the checklist to which belongs the check
check.external_id:
integer
The external ID of the check

Result Format


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 }}