{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/:id/advance","auth":"required","examples":{"codes":[{"code":"curl -X PUT -H 'Content-Type: application/json' -H 'X-ACCESS-TOKEN: secret-api-token' -d '{\"skip_automated_action\":\"true\"}' 'https://api.fountain.com/v2/applicants/:applicant_id/advance'","language":"curl"}]},"method":"put","results":{"codes":[{"name":"","code":"{ }","language":"json","status":204},{"name":"","code":"{\n \"message\": \"Authentication is required\"\n}","language":"json","status":401}]},"settings":"","params":[{"name":"id","type":"string","default":"22222222-0000-0000-0000-000000000000","desc":"An applicant's UUID","required":true,"in":"path","ref":"","_id":"5a588a3afe845d001253e8e9"},{"name":"stage_id","type":"string","default":"dc1fe619-2842-4a32-a2b5-0a6c53bfd7e2","desc":"Destination stage's external id. If not provided, the applicant will advance to the next stage by default.","required":false,"in":"query","ref":"","_id":"5ea1dcb79235bd004a965b4e"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60db90d4e89db50044e4765f"},{"name":"skip_automated_actions","type":"boolean","default":"false","desc":"Set `true` if you want to skip automated actions when advancing the applicant","required":false,"in":"body","ref":"","_id":"618d73d0255c4400418c113c"}]},"next":{"description":"","pages":[]},"title":"Advance an Applicant","type":"endpoint","slug":"advance-an-applicant","excerpt":"","body":"This method moves an applicant to an appropriate stage if specified or to the next stage by default.\n\nAll automated actions associated with the target stage are invoked by default.\n\nYou can skip the automated actions using the `skip_automated_actions` parameter set to `\"true\"`.","updates":["58953f5ff401510f0049f573"],"order":9,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f6900","user":"547504ed59fade080004cb8b","__v":14,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Applicant Management","slug":"endpoints","order":2,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68fa","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"createdAt":"2016-02-19T01:01:16.044Z"},"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"},"parentDoc":null,"project":"59de6011debd1200240f68ec","createdAt":"2017-01-20T17:26:50.266Z","githubsync":""}
putAdvance an Applicant
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
id:
required
string22222222-0000-0000-0000-000000000000
An applicant's UUID
Query Params
stage_id:
stringdc1fe619-2842-4a32-a2b5-0a6c53bfd7e2
Destination stage's external id. If not provided, the applicant will advance to the next stage by default.
Body Params
skip_automated_actions:
booleanfalse
Set `true` if you want to skip automated actions when advancing the applicant
Headers
X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token