{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/:applicant_id/notes","auth":"required","method":"post","examples":{"codes":[{"language":"curl","code":"curl -X POST -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'"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": \"f8b90c19-4d6a-494f-9457-50bf88f44f2e\",\n  \"content\": \"Good candidate\",\n  \"created_at\": \"2017-12-12T14:25:07.840-08:00\",\n  \"updated_at\": \"2017-12-12T14:25:07.840-08:00\",\n  \"user\": null\n}","name":""}]},"params":[{"name":"applicant_id","type":"string","default":"22222222-0000-0000-0000-000000000000","desc":"Applicant ID","required":true,"in":"path","ref":"","_id":"5a8bff26c4fa5b0049f34f88"},{"name":"content","type":"string","default":"Good candidate","desc":"Content of the note","required":true,"in":"query","ref":"","_id":"5ea1d9d378ec45006d0e16c1"},{"name":"api_token","type":"string","default":"secret_api_key","desc":"API Token (not required if api_token is passed in header)","required":false,"in":"query","ref":"","_id":"5ea1d9d378ec45006d0e16c0"}]},"next":{"description":"","pages":[]},"title":"Create a Note for Applicant","type":"endpoint","slug":"create-note-for-applicant","excerpt":"","body":"Create a new note associated to an applicant.\n\n# Response schema\n\n*   id\n    *   Required: yes\n    *   Type: string\n    *   Example: \"f8b90c19-4d6a-494f-9457-50bf88f44f2e\"\n*   content\n    *   Required: yes\n    *   Type: string\n    *   Example: \"Good candidate\"\n*   created_at\n    *   Required: yes\n    *   Type: string\n    *   Format: date-time\n    *   Example: \"2017-12-12T14:25:07.840-08:00\"\n*   updated_at\n    *   Required: yes\n    *   Type: string\n    *   Format: date-time\n    *   Example: \"2017-12-12T14:25:07.840-08:00\"\n*   user\n    *   Required: no\n    *   Type: null\n    *   Example: \"\"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a8c023ff4146e00449cece2","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:10:55.867Z","githubsync":"","__v":14,"parentDoc":null}

postCreate a Note for Applicant


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

applicant_id:
required
string22222222-0000-0000-0000-000000000000
Applicant ID

Query Params

content:
required
stringGood candidate
Content of the note
api_token:
stringsecret_api_key
API Token (not required if api_token is passed in header)

Examples


Result Format


Documentation

Create a new note associated to an applicant. # Response schema * id * Required: yes * Type: string * Example: "f8b90c19-4d6a-494f-9457-50bf88f44f2e" * content * Required: yes * Type: string * Example: "Good candidate" * created_at * Required: yes * Type: string * Format: date-time * Example: "2017-12-12T14:25:07.840-08:00" * updated_at * Required: yes * Type: string * Format: date-time * Example: "2017-12-12T14:25:07.840-08:00" * user * Required: no * Type: null * Example: ""

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}