{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/custom-fields/:custom_field_id","auth":"required","settings":"","results":{"codes":[{"name":"","code":"[\n  Candidate Custom Field Object\n]","language":"json","status":200},{"name":"Missing Access Token","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","language":"json","status":400},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"updateCandidateCustomFieldsError\",\n        \"message\": \"there was an unknown error updating candidate fields.\"\n    }\n}","language":"json","status":500}]},"params":[{"name":"company_id","type":"string","default":"","desc":"company id","required":false,"in":"path","ref":"","_id":"60f86d7494f1a400728ff55e"},{"name":"position_id","type":"string","default":"","desc":"position id","required":false,"in":"path","ref":"","_id":"60f86d7494f1a400728ff55f"},{"name":"candidate_id","type":"string","default":"","desc":"candidate id","required":false,"in":"path","ref":"","_id":"60f86d7494f1a400728ff560"},{"name":"custom_field_id","type":"string","default":"","desc":"custom field id","required":false,"in":"path","ref":"","_id":"60f86d7494f1a400728ff561"},{"name":"value","type":"mixed","default":"","desc":"","required":false,"in":"body","ref":"","_id":"60f86d7494f1a400728ff562"}],"examples":{"codes":[{"code":"PUT /v3/company/000000000000/position/000000000000/candidate/000000000000/custom-fields/000000000000\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"value\": \"new value\"\n}","language":"http"},{"code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X PUT -d '{ \"value\": \"new value\"}' https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/custom-fields/000000000000\n","language":"curl"}]},"method":"put"},"next":{"description":"","pages":[]},"title":"./candidate/:id/custom-fields/:id","type":"endpoint","slug":"candidateidcustom-fieldsid","excerpt":"","body":"","updates":[],"order":26,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60f86d7494f1a400728ff55d","createdAt":"2021-07-21T18:54:44.007Z","user":"60da404c0a190c005b179446","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},"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},"project":"54ee19c23749bf0d00c76515","__v":0,"parentDoc":null}

put./candidate/:id/custom-fields/:id


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
string
company id
position_id:
string
position id
candidate_id:
string
candidate id
custom_field_id:
string
custom field id

Body Params

value:
mixed

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