{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/funnels/:id","auth":"required","settings":"","results":{"codes":[{"language":"json","code":"{\n  \"title\": \"Internal Creative Representative\",\n  \"address\": \"\",\n  \"time_zone\": \"UTC\",\n  \"description\": \"\",\n  \"requirements\": \"\",\n  \"fields\": [],\n  \"is_private\": false,\n  \"active\": true,\n  \"custom_id\": \"31337-31338-31339\",\n  \"id\": \"d91b5774-f62f-40ae-b4f1-15c0c1d2b861\",\n  \"stages\": [\n    {\n      \"title\": \"Approved\",\n      \"type\": \"HiredStage\",\n      \"id\": \"43f9c373-bde9-4b9a-84f6-2e3e6cb3d126\"\n    }\n  ],\n  \"location\": {\n    \"id\": \"7f88228c-cba9-4827-b71d-e81244c05d37\",\n    \"name\": \"San Francisco\"\n  }\n}","name":"","status":200}]},"method":"put","examples":{"codes":[{"language":"curl","code":"curl -X PUT -H 'Content-Type: application/json' -d '{\"custom_id\":\"31337-31338-31339\",\"api_token\":\"fixture-api-token\"}' 'https://www.onboardiq.com/api/v2/funnels/d91b5774-f62f-40ae-b4f1-15c0c1d2b861'"}]},"params":[{"name":"id","type":"string","default":"550e8400-e29b-41d4-a716-446655440000","desc":"ID must be included in the URL","required":false,"in":"path","ref":"","_id":"579be22b5623be2200832673"},{"name":"api_token","type":"string","default":"secret-api-token","desc":"Required if api_token is not passed in header","required":false,"in":"query","ref":"","_id":"579be22b5623be2200832672"},{"name":"custom_id","type":"string","default":"","desc":"","required":false,"in":"query","ref":"","_id":"595e731c853dd00015348212"}]},"next":{"description":"","pages":[]},"title":"Update Opening","type":"endpoint","slug":"update-position","excerpt":"","body":"## Update Opening","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f6939","project":"59de6011debd1200240f68ec","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Openings and Stages","slug":"positions-and-stages","order":7,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68f7","version":"59de6011debd1200240f68ee","project":"59de6011debd1200240f68ec","__v":0,"createdAt":"2016-02-22T18:56:04.107Z"},"user":"547504ed59fade080004cb8b","__v":5,"parentDoc":null,"createdAt":"2017-07-06T17:27:56.940Z","githubsync":""}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string550e8400-e29b-41d4-a716-446655440000
ID must be included in the URL

Query Params

api_token:
stringsecret-api-token
Required if api_token is not passed in header
custom_id:
string

Examples


Result Format


Documentation

## Update Opening

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