{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id","auth":"required","examples":{"codes":[{"code":"PUT /v3/company/000000000000/position/000000000000 HTTP/1.1\nHost: api.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  \"custom_attributes\": [\n  \t{\n    \t\"name\": \"Max Salary\",\n      \"value\": \"1000000\",\n      \"secure\": true\n    }\n  ],\n  \"pipeline_id\": \"000000000000\", \n  \"scorecard_id\": \"000000000000\", \n  \"questionnaire_id\": \"000000000000\",\n  \"tags\": [\"technical\", \"junior\"]\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\",\"custom_attributes\": [ { \"name\": \"Max Salary\", \"value\": \"1000000\", \"secure\": true }], \"pipeline_id\": \"000000000000\", \"scorecard_id\": \"000000000000\", \"questionnaire_id\": \"000000000000\",\"tags\": [\"technical\", \"junior\"] }' https://api.breezy.hr/v3/company/000000000000/position/000000000000\n\n"}]},"settings":"","results":{"codes":[{"name":"","code":"{\n   Position Object\n}","language":"json","status":200},{"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}"}]},"method":"put","params":[{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b06fb1641a1700ede46d"},{"name":"name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad9d"},{"name":"description","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad9c"},{"name":"type","type":"string","default":"","desc":"fullTime | partTime | contract | temporary | other","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad9b"},{"name":"location","type":"object","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad9a"},{"name":"department","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad99"},{"name":"requisition_id","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad98"},{"name":"category","type":"string","default":"","desc":"software | design | product | sysadmin | devops | finance | custserv | sales | marketing | pr | design-not-interactive | hr | management | operations | other","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad97"},{"name":"experience","type":"string","default":"","desc":"na | internship | entry-level | associate | mid-level | senior-level | executive","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad96"},{"name":"education","type":"string","default":"","desc":"unspecified | high-school | certification | vocational | associate-degree | bachelor-degree | masters-degree | doctorate | professional | some-college | vocational-diploma | vocational-degree | some-high-school","required":false,"in":"body","ref":"","_id":"5a68be3454e5890028f3ad95"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"5a68de4870ea610012bfb833"},{"name":"custom_attributes","type":"array_object","default":"","desc":"{ name: String, value: String, secure: Boolean } - secure determines if the value should be encrypted at rest","required":false,"in":"body","ref":"","_id":"5c8131b5020ff2003873e150"},{"name":"pipeline_id","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cb3c961b542f100327f263f"},{"name":"scorecard_id","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cc9f599f8503e004532ecda"},{"name":"questionnaire_id","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cc9f599f8503e004532ecd9"},{"name":"tags","type":"array_string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5ef9d850a01e730033ebf39b"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./position/:id","type":"endpoint","slug":"company-position-update","excerpt":"Update details for given position","body":"","updates":["5bdf9b6f01b28a004ad3990d"],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a68dd42cb2b8c0012b53346","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-24T19:23:46.994Z","githubsync":"","__v":16,"parentDoc":null,"updatedAt":"2019-07-05T13:53:50.842Z"}

put./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
custom_attributes:
array of objects
{ name: String, value: String, secure: Boolean } - secure determines if the value should be encrypted at rest
pipeline_id:
string
scorecard_id:
string
questionnaire_id:
string
tags:
array of strings

Examples


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