{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/custom-attribute","auth":"required","examples":{"codes":[{"language":"http","gist":"d8b94c22c836cf372959","name":"","code":"PUT /v3/company/000000000000/position/000000000000/candidate/000000000000/custom-attribute HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"name\": \"Desired Salary\",\n\t\"value\": \"100000\"\n\t\"secure\": true\n}"},{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X PUT -d '{\"name\": \"Desired Salary\",\"value\": \"100000\"\"secure\": true}' https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/custom-attribute\n\n"}]},"method":"put","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n   Candidate Object\n}"},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token"},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"updateCandidateError\",\n        \"message\": \"there was an unknown error updating candidate.\"\n    }\n}","language":"json","status":500}]},"settings":"","params":[{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b2f81ec0f519003e6130"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b2f81ec0f519003e612f"},{"name":"candidate_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"5b7db1d323ad950003c4ae30"},{"name":"name","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5c8034b90e71c9004226b58b"},{"name":"value","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5c8034b90e71c9004226b58a"},{"name":"secure","type":"boolean","default":"false","desc":"Does this value need to be encrypted at rest?","required":false,"in":"body","ref":"","_id":"5c8034b90e71c9004226b589"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id/custom-attribute","type":"endpoint","slug":"company-position-candidate-custom-attribute-update","excerpt":"Adds a custom-attribute to a candidate","body":"","updates":[],"order":6,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c803406937e7300348cc097","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":"Candidate Endpoints","slug":"candidate-endpoints","order":6,"from_sync":false,"reference":true,"_id":"5a60f64d792a330012d72146","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2015-02-25T20:55:14.360Z","__v":0},"user":"575f003663430e0e008a8704","createdAt":"2019-03-06T20:56:38.333Z","__v":2,"parentDoc":null,"updatedAt":"2019-07-05T13:06:44.441Z"}

put./candidate/:id/custom-attribute

Adds a custom-attribute to a candidate

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string
candidate_id:
required
string

Body Params

name:
required
string
value:
required
string
secure:
booleanfalse
Does this value need to be encrypted at rest?

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