Warning: API actions should only be performed by individuals who are familiar with these protocols, as improper use can lead to problems. If you are not confident with APIs, please contact our Support Team, who can help set up these Triggers for you.


In the ever-evolving landscape of recruitment and talent acquisition, making informed decisions about job applicants is crucial. One decision that often requires careful consideration is whether to flag an applicant as "Do Not Hire." Making the right choices about who not to hire can save your organization valuable time, resources, and even reputation. Read on to learn more about how you can utilize our API to identify those candidates that you've flagged as "Do Not Hire".


Once you identify a candidate that you would like to flag as"Do Not Hire", you'll need to take note of their email address and then jump over to the API Platform of your choice (we find Postman to be a great resource here!). 


Add the "Do Not Hire" Tag

Set up an Action via API to automatically add the "Do Not Hire" tag to any new application that comes in with the email address matching the one on the candidate profile you have identified for the flag.


API Verb: POST 

Request URL: https://api.applicant-tracking.com/api/v1/triggers

Body: Raw / JSON

{
  "event_type": "applicant_new",
  "action_type": "tag_app",
  "data": { "tag_text": "do not hire" },
  "conditions": {
    "if": {
        "and": {
            "==" : [{ "user" : "email" }, "EMAIl ADDRESS OF USER" ]
        }
    }
  }
}

Authorization: Basic Auth - use your API keys from your ATS account (located by going to Menu < Account Details < API Access) 


Example of Postman Body: 


When an applicant applies with an email address that you have flagged, this tag will appear on their applicant profile. 



Automatically Archive the Applicant

You may also choose to automatically archive the candidate instead of just adding the tag. The process is quite similar to the one above, only you will use the mark_as_archived action instead of the tag_app action. 


API Verb: POST 

Request URL: https://api.applicant-tracking.com/api/v1/triggers

Body: Raw / JSON

{
  "event_type": "applicant_new",
  "action_type": "mark_as_archived",
  "conditions": {
    "if": {
        "and": {
            "==" : [{ "user" : "email" }, "EMAIl ADDRESS OF USER" ]
        }
    }
  }
}

Authorization: Basic Auth - use your API keys from your ATS account (located by going to Menu < Account Details < API Access) 


Example of Postman Body: 


When an applicant applies with an email address that you have flagged, their application will be automatically archived. 


You can use one or both of these actions together to help identify candidates that you have flagged as "Do Not Hire".


To learn more about all the cool things you can do using our API, check out our helpful API docs here.