Merge API Documentation

curl -X POST https://api.merge.dev/api/ats/v1/candidates \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {},
  "remote_user_id": "string"
}'

1	{
2	"model": {
3	"id": "521b18c2-4d01-4297-b451-19858d07c133",
4	"remote_id": "21198",
5	"created_at": "2021-09-15T00:00:00Z",
6	"modified_at": "2021-10-16T00:00:00Z",
7	"first_name": "Gil",
8	"last_name": "Feig",
9	"company": "Columbia Dining App.",
10	"title": "Software Engineer",
11	"remote_created_at": "2021-10-15T00:00:00Z",
12	"remote_updated_at": "2021-10-16T00:00:00Z",
13	"last_interaction_at": "2021-10-17T00:00:00Z",
14	"is_private": true,
15	"can_email": true,
16	"locations": [
17	"San Francisco",
18	"New York",
19	"Miami"
20	],
21	"phone_numbers": [
22	{
23	"value": "+1234567890",
24	"phone_number_type": "MOBILE"
25	}
26	],
27	"email_addresses": [
28	{
29	"value": "[email protected]",
30	"email_address_type": "PERSONAL"
31	}
32	],
33	"urls": [
34	{
35	"value": "http://alturl.com/p749b",
36	"url_type": "BLOG"
37	}
38	],
39	"tags": [
40	"High-Priority"
41	],
42	"applications": [
43	"29eb9867-ce2a-403f-b8ce-f2844b89f078",
44	"b4d08e5c-de00-4d64-a29f-66addac9af99",
45	"4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"
46	],
47	"attachments": [
48	"bea08964-32b4-4a20-8bb4-2612ba09de1d"
49	],
50	"remote_was_deleted": true,
51	"field_mappings": {
52	"organization_defined_targets": {
53	"custom_key": "custom_value"
54	},
55	"linked_account_defined_targets": {
56	"custom_key": "custom_value"
57	}
58	},
59	"remote_data": [
60	{
61	"path": "/candidates"
62	}
63	]
64	},
65	"warnings": [
66	{
67	"title": "Unrecognized Field",
68	"detail": "An unrecognized field, age, was passed in with request data.",
69	"problem_type": "UNRECOGNIZED_FIELD",
70	"source": {
71	"pointer": "/age"
72	},
73	"block_merge_link": true,
74	"raw_error": "string",
75	"error_code": 1
76	}
77	],
78	"errors": [
79	{
80	"title": "Missing Required Field",
81	"detail": "custom_fields is a required field on model.",
82	"problem_type": "MISSING_REQUIRED_FIELD",
83	"source": {
84	"pointer": "/model/custom_fields"
85	},
86	"block_merge_link": true,
87	"raw_error": "string",
88	"error_code": 1
89	}
90	],
91	"logs": [
92	{
93	"log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
94	"dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
95	"log_summary": {
96	"url": "www.exampleintegration.com/api/v1/exampleapi",
97	"method": "POST",
98	"status_code": 200
99	}
100	}
101	]
102	}

Creates a Candidate object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

Usage Example

Fetch from the LIST Candidates endpoint and filter by ID to show all candidates.

remote_user_idstringRequired

Response

modelobject

Description

The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

Usage Example

Fetch from the LIST Candidates endpoint and filter by ID to show all candidates.

warningslist of objects

errorslist of objects

logslist of objects

/candidates

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration