⭐ [New] Track a Profile or a Job

post

https://api.hrflow.ai/v1/tracking

This endpoint allows you to track a Profile (resp. a Job) for Job (resp. a Profile) as a recruiter (resp. a candidate) with a specific action

Body Params

action

string

required

The 'action' refers to a unique identifier for a profile or job stage. This can be a specific stage ID within a CRM, ATS, or Job site. Examples of such stages include "view," "apply," "hire," or any other stage relevant to your system.

role

string

required

Role of the user rating the job (role: recruiter, candidate, employee, manager).

board_key

string

required

The key of Board attached to the given Job.

job_key

string

The Job's unique identifier.

job_reference

string

The Job reference chosen by the customer or an external system. If you use the job_key you do not need to specify the job_reference and vice versa.

source_key

string

required

The key of Source attached to the given Profile.

profile_key

string

The Profile's unique identifier.

profile_reference

string

The Profile reference chosen by the customer or an external system. If you use the profile_key you do not need to specify the profile_reference and vice versa.

author_email

string

Email of the HrFlow.ai user who rated the profile for the job.

comment

string

Comment explaining the reason behind the score.

created_at

string

ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX — for example, "2000-10-31T01:30:00.000-05:00". It associates a creation date to the profile (ie: this can be for example the original date of the application of the profile). If not provided the creation date will be now by default.

Response

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200