Terminology
remote_id: A field within Merge's candidate common model
Contact: The Contact value assigned to an Opportunity in Lever
Mapping a candidate's remote_id against a Lever opportunity
In order to populate the candidate common model, Merge fetches opportunities from Lever as Lever deprecated the previously used candidate endpoints.
The opportunities provided by Lever will look like the below example:
{
"data": [
{
"id": "250d8f03-738a-4bba-a671-8a3d73477145",
"name": "Shane Smith",
"headline": "Brickly LLC, Vandelay Industries, Inc, Central Perk",
"contact": "7f23e772-f2cb-4ebb-b33f-54b872999992",
"emails": [
"[email protected]"
],
"phones": [
{
"value": "(123) 456-7891"
}
],
...
Intuitively, one might expect the id of an opportunity to become Merge's remote_id. Lever's documentation, does however, suggest using the contact instead:
Going forward, the contact field is the unique identifier for a Contact or an individual person in Lever, so all integrations should be built and updated using the contact as the unique person identifier (...)
Merge follows this suggestion and uses the contact value as the remote_id of a candidate.