{"_id":"5a8c0a70e86f530012159d9c","project":"59de6011debd1200240f68ec","version":{"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"5a8bfcf2e86f530012159bb2","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-02-20T10:48:18.428Z","from_sync":false,"order":4,"slug":"notes-management","title":"Notes Management"},"user":"547504ed59fade080004cb8b","githubsync":"","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-20T11:45:52.302Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","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}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"curl -X PUT -H 'Content-Type: application/json' -d '{\"api_token\":\"secret-api-token\",\"content\":\"Good candidate\"}' 'https://api.fountain.com/v2/applicants/22222222-0000-0000-0000-000000000000/notes/11111111-0000-0000-0000-000000000000'","language":"curl"}]},"method":"put","auth":"required","params":[{"_id":"5a8bff26c4fa5b0049f34f88","ref":"","in":"path","required":false,"desc":"ID of the applicant","default":"22222222-0000-0000-0000-000000000000","type":"string","name":"applicant_id"},{"_id":"5a8c023ff4146e00449cece3","ref":"","in":"body","required":false,"desc":"","default":"Good candidate","type":"string","name":"content"},{"_id":"5a8c0288e86f530012159cd0","ref":"","in":"body","required":false,"desc":"required if api_token is not passed in by header","default":"secret_api_key","type":"string","name":"api_token"},{"_id":"5a8c0a70e86f530012159d9d","ref":"","in":"path","required":false,"desc":"ID of the note","default":"11111111-0000-0000-0000-000000000000","type":"string","name":"id"}],"url":"/applicants/:applicant_id/notes/:id"},"isReference":false,"order":3,"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>\\\"derick@brekkehowell.co\\\"</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]","excerpt":"","slug":"update-applicant-note","type":"endpoint","title":"Update Applicant Note"}

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

Body Params

content:
stringGood candidate
api_token:
stringsecret_api_key
required if api_token is not passed in by header

Examples


Result Format


Documentation

## Response schema [block:html] { "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>\"derick@brekkehowell.co\"</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>" } [/block]

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