{"_id":"5a68dd42cb2b8c0012b53346","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","githubsync":"","__v":4,"parentDoc":null,"updates":["5bdf9b6f01b28a004ad3990d"],"next":{"pages":[],"description":""},"createdAt":"2018-01-24T19:23:46.994Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"PUT /public/api/v3/company/000000000000/position/000000000000 HTTP/1.1\nHost: breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"name\": \"New Job\",\n  \"type\": \"fullTime\",\n  \"description\": \"This is the job description\",\n  \"location\": {\n\t\t\"country\": \"US\",\n\t\t\"state\": \"FL\",\n\t\t\"city\": \"Jacksonville\",\n\t\t\"is_remote\": false\n  },\n  \"education\":\"high-school\",\n  \"category\": \"sysadmin\",\n  \"experience\": \"internship\"\n}","language":"http"},{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X PUT -d '{ \"name\": \"New Job\", \"type\": \"fullTime\", \"description\": \"This is the job description\", \"location\": { \"country\": \"US\", \"state\": \"FL\", \"city\": \"Jacksonville\", \"is_remote\": false }, \"education\":\"high-school\", \"category\": \"sysadmin\", \"experience\": \"internship\" }' https://breezy.hr/public/api/v3/company/000000000000/position/000000000000\n\n"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n   Position Object\n}","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}]},"method":"post","auth":"required","params":[{"_id":"57a8b06fb1641a1700ede46d","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"company_id"},{"_id":"5a68be3454e5890028f3ad9d","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"name"},{"_id":"5a68be3454e5890028f3ad9c","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"description"},{"_id":"5a68be3454e5890028f3ad9b","ref":"","in":"body","required":false,"desc":"fullTime | partTime | contract | temporary | other","default":"","type":"string","name":"type"},{"_id":"5a68be3454e5890028f3ad9a","ref":"","in":"body","required":false,"desc":"","default":"","type":"object","name":"location"},{"_id":"5a68be3454e5890028f3ad99","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"department"},{"_id":"5a68be3454e5890028f3ad98","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"requisition_id"},{"_id":"5a68be3454e5890028f3ad97","ref":"","in":"body","required":false,"desc":"software | design | product | sysadmin | devops | finance | custserv | sales | marketing | pr | design-not-interactive | hr | management | operations | other","default":"","type":"string","name":"category"},{"_id":"5a68be3454e5890028f3ad96","ref":"","in":"body","required":false,"desc":"na | internship | entry-level | associate | mid-level | senior-level | executive","default":"","type":"string","name":"experience"},{"_id":"5a68be3454e5890028f3ad95","ref":"","in":"body","required":false,"desc":"unspecified | high-school | certification | vocational | associate-degree | bachelor-degree | masters-degree | doctorate | professional | some-college | vocational-diploma | vocational-degree | some-high-school","default":"","type":"string","name":"education"},{"_id":"5a68de4870ea610012bfb833","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"position_id"}],"url":"/v:version/company/:company_id/position/:position_id"},"isReference":true,"order":1,"body":"","excerpt":"Update details for given position","slug":"company-position-update","type":"endpoint","title":"./position/:id"}

post./position/:id

Update details for given position

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string

Body Params

name:
string
description:
string
type:
string
fullTime | partTime | contract | temporary | other
location:
object
department:
string
requisition_id:
string
category:
string
software | design | product | sysadmin | devops | finance | custserv | sales | marketing | pr | design-not-interactive | hr | management | operations | other
experience:
string
na | internship | entry-level | associate | mid-level | senior-level | executive
education:
string
unspecified | high-school | certification | vocational | associate-degree | bachelor-degree | masters-degree | doctorate | professional | some-college | vocational-diploma | vocational-degree | some-high-school

Examples


Result Format


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