{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/state","auth":"required","method":"put","results":{"codes":[{"name":"","code":"","language":"json","status":204},{"language":"json","status":400,"name":"Missing Access Token","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}"},{"code":"{\n    \"error\": {\n        \"type\": \"addPosition<Field>Missing\",\n        \"message\": \"<field> is null or empty\"\n    }\n}","language":"json","name":"Missing Required Field","status":400},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"name":null,"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"addPositionFieldInvalid\",\n        \"message\": \"<field>  must be one of the following values: <values>\"\n    }\n}"},{"status":500,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"updatePositionError\",\n        \"message\": \"there was an unknown error updating position.\"\n    }\n}"}]},"settings":"","examples":{"codes":[{"language":"http","code":"PUT /v3/company/000000000000/position/000000000000/state HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"state\": \"closed\"  \n}"},{"code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X PUT -d '{ \"state\": \"closed\" }' https://api.breezy.hr/v3/company/000000000000/position/000000000000/state\n\n","language":"curl"}]},"params":[{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b06fb1641a1700ede46d"},{"name":"state","type":"string","default":"","desc":"published | draft | closed | archived","required":true,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad9d"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"5a68de4870ea610012bfb833"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./position/:id/state","type":"endpoint","slug":"company-position-state-update","excerpt":"Update details for given position","body":"This should be `PUT` (the api doesn't let you POST, so it's just the documentation incorrect)","updates":["5bdf9b9301b28a004ad3990e"],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a68ed10777d2f00121fb6e1","project":"54ee19c23749bf0d00c76515","version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568","5d1f4985a718ba002bfa4a52","5d1f53e3d10632001825a1f3"],"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","__v":4},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Position Endpoints","slug":"position-endpoints","order":5,"from_sync":false,"reference":true,"_id":"5a60f64d792a330012d72145","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2015-02-25T20:55:04.025Z","__v":0},"user":"575f003663430e0e008a8704","createdAt":"2018-01-24T20:31:12.695Z","githubsync":"","__v":7,"parentDoc":null,"updatedAt":"2019-07-05T13:05:40.903Z"}

put./position/:id/state

Update details for given position

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string

Body Params

state:
required
string
published | draft | closed | archived

Examples


Documentation

This should be `PUT` (the api doesn't let you POST, so it's just the documentation incorrect)

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