{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/:applicant_id/notes/:id","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": \"11111111-0000-0000-0000-000000000000\",\n \"content\": \"Good candidate\",\n \"created_at\": \"2017-12-12T14:26:08.733-08:00\",\n \"updated_at\": \"2017-12-12T14:26:08.748-08:00\",\n \"user\": {\n \"name\": \"Doug Collier\",\n \"email\": \"derick:::at:::example.com\",\n \"id\": \"e3e5c560-60ff-46a7-a279-c1968540a600\"\n }\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X PUT -H 'Content-Type: application/json' -H 'X-ACCESS-TOKEN: secret-api-token' -d '{\"content\":\"Good candidate\"}' 'https://api.fountain.com/v2/applicants/22222222-0000-0000-0000-000000000000/notes/11111111-0000-0000-0000-000000000000'"}]},"method":"put","params":[{"name":"applicant_id","type":"string","default":"22222222-0000-0000-0000-000000000000","desc":"ID of the applicant","required":false,"in":"path","ref":"","_id":"5a8bff26c4fa5b0049f34f88"},{"name":"id","type":"string","default":"11111111-0000-0000-0000-000000000000","desc":"ID of the note","required":false,"in":"path","ref":"","_id":"5a8c0a70e86f530012159d9d"},{"name":"content","type":"string","default":"Good candidate","desc":"","required":false,"in":"query","ref":"","_id":"5ea1dffc78ec45006d0e2fe2"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60dcd554e9496400691a9749"}]},"next":{"description":"","pages":[]},"title":"Update Applicant Note","type":"endpoint","slug":"update-applicant-note","excerpt":"","body":"## Response schema\n[block:html]\n{\n \"html\": \"<ul><li>additionalProperties: false</li><li> <span id=\\\"id-0--563538675499970456\\\">\\n <a href=\\\"#id-0--563538675499970456\\\" class=\\\"anchor\\\">\\n <tt>id</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"adb65574-523d-45e8-8e93-2f8457898370\\\"</tt></li></ul></div></li><li> <span id=\\\"content-0-2240601560468545275\\\">\\n <a href=\\\"#content-0-2240601560468545275\\\" class=\\\"anchor\\\">\\n <tt>content</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Good candidate\\\"</tt></li></ul></div></li><li> <span id=\\\"created_at-0-2782100799123717598\\\">\\n <a href=\\\"#created_at-0-2782100799123717598\\\" class=\\\"anchor\\\">\\n <tt>created_at</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>\\\"2017-12-12T14:26:08.733-08:00\\\"</tt></li></ul></div></li><li> <span id=\\\"updated_at-0--2295390930552994635\\\">\\n <a href=\\\"#updated_at-0--2295390930552994635\\\" class=\\\"anchor\\\">\\n <tt>updated_at</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>\\\"2017-12-12T14:26:08.748-08:00\\\"</tt></li></ul></div></li><li> <span id=\\\"user-0--4541189858416395490\\\">\\n <a href=\\\"#user-0--4541189858416395490\\\" class=\\\"anchor\\\">\\n <tt>user</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\\\"name-1--1860445827134834983\\\">\\n <a href=\\\"#name-1--1860445827134834983\\\" class=\\\"anchor\\\">\\n <tt>name</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Doug Collier\\\"</tt></li></ul></div></li><li> <span id=\\\"email-1--2160373669032085373\\\">\\n <a href=\\\"#email-1--2160373669032085373\\\" class=\\\"anchor\\\">\\n <tt>email</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"[email protected]\\\"</tt></li></ul></div></li><li> <span id=\\\"id-1--1191812873342327564\\\">\\n <a href=\\\"#id-1--1191812873342327564\\\" class=\\\"anchor\\\">\\n <tt>id</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"e3e5c560-60ff-46a7-a279-c1968540a600\\\"</tt></li></ul></div></li></ul></div></li></ul>\"\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a8c0a70e86f530012159d9c","project":"59de6011debd1200240f68ec","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Notes Management","slug":"notes-management","order":4,"from_sync":false,"reference":false,"_id":"5a8bfcf2e86f530012159bb2","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2018-02-20T10:48:18.428Z","__v":0},"user":"547504ed59fade080004cb8b","createdAt":"2018-02-20T11:45:52.302Z","githubsync":"","__v":8,"parentDoc":null}putUpdate Applicant Note
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
applicant_id:
string22222222-0000-0000-0000-000000000000
ID of the applicant
id:
string11111111-0000-0000-0000-000000000000
ID of the note
Query Params
content:
stringGood candidate
Headers
X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token