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

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


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