{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/advance?:stage_id","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{ }","language":"json","status":204},{"name":null,"code":"{\n  \"message\": \"Too many applicants given; Bulk advance supports up to 500 applicants at a time\"\n}","language":"json","status":422},{"code":"{\n  \"message\": \"Applicant(s) not found for the following applicant IDs\",\n  \"ids\": [\n    \"67da8edf-53f6-4704-8bfe-94c18a51589a\"\n  ]\n}","language":"json","status":422},{"code":"{\n  \"message\": \"Cannot bulk move applicants into stages that require manual data validation\"\n}","language":"json","status":422}]},"params":[{"name":"stage_id","type":"string","default":"6skjwoa36-dcqf-4c93-895f-13532c242kl","desc":"Destination stage's external id. All specified applicants will advance to this stage.","required":true,"in":"query","ref":"","_id":"6179d940c3099f002311d32e"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"6179d940c3099f002311d32f"},{"name":"ids","type":"array_string","default":"{   \"ids\": [     \"ce8702b0-5d02-0139-d165-3e22fbe8d4d1\",     \"012e7703-0595-424c-8d3b-28cf15b0024c\"   ] }","desc":"List of applicant IDs (limit of 500)","required":true,"in":"body","ref":"","_id":"618d724d380055027db797b6"},{"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":"618e9cbe76da1c006a52da90"}],"examples":{"codes":[{"code":"curl -X POST -H 'X-ACCESS-TOKEN: abc123' 'https://api.fountain.com/v2/applicants/advance?stage_id=52bdfa36-ccff-4c93-895f-1353k4k3l2n' -d '{\"ids\": [\"67da8edf-jk89-4704-8bfe-94c18a515898\", \"485822a7-0c26-4ae0-9b9q-5ab73f1b0cad\"], \"skip_automated_actions\": \"true\"}'","language":"curl","name":"cURL"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Bulk Advance Multiple Applicants","type":"endpoint","slug":"bulk-advance-multiple-applicants","excerpt":"","body":"This method advances up to 500 applicants to a specified destination stage.\n\nBy default, successful requests will trigger all automated actions associated with the destination stage.\nYou can skip the automated actions by setting the `skip_automated_actions` parameter to `true`. This setting will apply to all automated actions associated with the target stage.\n\nIf the request fails for any reason, then none of the specified applicants will be moved. Failed requests will not trigger any automated actions associated with the specified target stage.\n\nThe applicant IDs provided in the `ids` parameter can refer to applicants from different stages and different openings within your account.\n\n\n[block:api-header]\n{\n  \"title\": \"Returns\"\n}\n[/block]\nReturns a 204 \"No Content\" status code if the request succeeds.\n\nReturns an error if provided parameters are invalid or if any specified moves violate existing workflow validations.","updates":[],"order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6179d7bb5c0909000f25b945","createdAt":"2021-10-27T22:50:35.417Z","user":"547504ed59fade080004cb8b","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"},"project":"59de6011debd1200240f68ec","__v":31,"parentDoc":null}

postBulk Advance Multiple Applicants


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

stage_id:
required
string6skjwoa36-dcqf-4c93-895f-13532c242kl
Destination stage's external id. All specified applicants will advance to this stage.

Body Params

ids:
required
array of strings{ "ids": [ "ce8702b0-5d02-0139-d165-3e22fbe8d4d1", "012e7703-0595-424c-8d3b-28cf15b0024c" ] }
List of applicant IDs (limit of 500)
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

Examples


Result Format


Documentation

This method advances up to 500 applicants to a specified destination stage. By default, successful requests will trigger all automated actions associated with the destination stage. You can skip the automated actions by setting the `skip_automated_actions` parameter to `true`. This setting will apply to all automated actions associated with the target stage. If the request fails for any reason, then none of the specified applicants will be moved. Failed requests will not trigger any automated actions associated with the specified target stage. The applicant IDs provided in the `ids` parameter can refer to applicants from different stages and different openings within your account. [block:api-header] { "title": "Returns" } [/block] Returns a 204 "No Content" status code if the request succeeds. Returns an error if provided parameters are invalid or if any specified moves violate existing workflow validations.

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