{"_id":"59de6011debd1200240f6911","parentDoc":null,"category":{"_id":"59de6011debd1200240f68fa","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-19T01:01:16.044Z","from_sync":false,"order":2,"slug":"endpoints","title":"Applicant Management"},"user":"547504ed59fade080004cb8b","version":{"_id":"59de6011debd1200240f68ee","__v":2,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"__v":4,"project":"59de6011debd1200240f68ec","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T01:35:00.445Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X DELETE -H 'Content-Type: application/json' -d '{\"api_token\":\"secret-api-token\"}' 'https://api.fountain.com/v2/applicants/01234567-0000-0000-0000-000000000000'"}]},"method":"delete","results":{"codes":[{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56c672c849937c0d001dec31","ref":"","in":"path","required":false,"desc":"The ID goes in the URL","default":"01234567-0000-0000-0000-000000000000","type":"string","name":"id"},{"_id":"56c67144ae78180d00930823","ref":"","in":"body","required":false,"desc":"required if api_token is not passed in header","default":"secret-api-token","type":"string","name":"api_token"}],"url":"/applicants/:id"},"isReference":false,"order":3,"body":"Delete an applicant by their ID.\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"NOTE: Delete with caution\",\n  \"body\": \"This will delete an applicant for good, please use with caution.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Move instead of DELETE?\",\n  \"body\": \"If you are not sure you want to delete an applicant completely, you can move him to a certain stage or assign him a specific label —  see applicant label management methods for that.\"\n}\n[/block]\n## Response Schema\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li></ul>\"\n}\n[/block]","excerpt":"","slug":"delete-apiv2applicantsid","type":"endpoint","title":"Delete an Applicant"}

deleteDelete an Applicant


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string01234567-0000-0000-0000-000000000000
The ID goes in the URL

Body Params

api_token:
stringsecret-api-token
required if api_token is not passed in header

Examples


Result Format


Documentation

Delete an applicant by their ID. [block:callout] { "type": "warning", "title": "NOTE: Delete with caution", "body": "This will delete an applicant for good, please use with caution." } [/block] [block:callout] { "type": "info", "title": "Move instead of DELETE?", "body": "If you are not sure you want to delete an applicant completely, you can move him to a certain stage or assign him a specific label — see applicant label management methods for that." } [/block] ## Response Schema [block:html] { "html": "<ul><li>additionalProperties: false</li></ul>" } [/block]

User Information

Try It Out

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