/applications/{id}/change-stage

Updates the current_stage field of an Application object

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

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.

job_interview_stagestring or nullOptionalformat: "uuid"

The interview stage to move the application to.

remote_user_idstringOptional>=1 character

Response

modelobject

Description

The Application Object is used to represent a candidate’s journey through a particular Job’s recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.

Usage Example

Fetch from the LIST Applications endpoint and filter by ID to show all applications.

# The Application Object ### Description The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it. ### Usage Example Fetch from the `LIST Applications` endpoint and filter by `ID` to show all applications.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

candidatestring or nullRequiredformat: "uuid"

The candidate applying.

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

applied_atdatetime or nullOptional

When the application was submitted.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

Supported POST model parameters

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

candidatestring or nullOptionalformat: "uuid"

The candidate applying.

applied_atdatetime or nullOptional

When the application was submitted.

rejected_atdatetime or nullOptional

When the application was rejected.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

reject_reasonstring or nullOptionalformat: "uuid"

The application's reason for rejection.

Supported POST model parameters

candidatestring or nullRequiredformat: "uuid"

The candidate applying.

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

applied_atdatetime or nullOptional

When the application was submitted.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

Supported POST model parameters

candidatestring or nullRequiredformat: "uuid"

The candidate applying.

remote_idstring or nullOptional

The third-party API ID of the matching object.

jobstring or nullOptionalformat: "uuid"

The job being applied for.

applied_atdatetime or nullOptional

When the application was submitted.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

Supported POST model parameters

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

candidatestring or nullOptionalformat: "uuid"

The candidate applying.

applied_atdatetime or nullOptional

When the application was submitted.

rejected_atdatetime or nullOptional

When the application was rejected.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

reject_reasonstring or nullOptionalformat: "uuid"

The application's reason for rejection.

Supported POST model parameters

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

candidatestring or nullOptionalformat: "uuid"

The candidate applying.

applied_atdatetime or nullOptional

When the application was submitted.

rejected_atdatetime or nullOptional

When the application was rejected.

sourcestring or nullOptional

The application's source.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

reject_reasonstring or nullOptionalformat: "uuid"

The application's reason for rejection.

Supported POST model parameters

candidatestring or nullRequiredformat: "uuid"

The candidate applying.

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

applied_atdatetime or nullOptional

When the application was submitted.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

Supported POST model parameters

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

candidatestring or nullOptionalformat: "uuid"

The candidate applying.

applied_atdatetime or nullOptional

When the application was submitted.

rejected_atdatetime or nullOptional

When the application was rejected.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

reject_reasonstring or nullOptionalformat: "uuid"

The application's reason for rejection.

Supported POST model parameters

candidatestring or nullRequiredformat: "uuid"

The candidate applying.

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

applied_atdatetime or nullOptional

When the application was submitted.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

Supported POST model parameters

candidatestring or nullRequiredformat: "uuid"

The candidate applying.

remote_idstring or nullOptional

The third-party API ID of the matching object.

jobstring or nullOptionalformat: "uuid"

The job being applied for.

applied_atdatetime or nullOptional

When the application was submitted.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

Supported POST model parameters

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

candidatestring or nullOptionalformat: "uuid"

The candidate applying.

applied_atdatetime or nullOptional

When the application was submitted.

rejected_atdatetime or nullOptional

When the application was rejected.

sourcestring or nullOptional

The application's source.

credited_tostring or nullOptionalformat: "uuid"

The user credited for this application.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

reject_reasonstring or nullOptionalformat: "uuid"

The application's reason for rejection.

Supported POST model parameters

jobstring or nullRequiredformat: "uuid"

The job being applied for.

remote_idstring or nullOptional

The third-party API ID of the matching object.

candidatestring or nullOptionalformat: "uuid"

The candidate applying.

applied_atdatetime or nullOptional

When the application was submitted.

rejected_atdatetime or nullOptional

When the application was rejected.

sourcestring or nullOptional

The application's source.

screening_question_answerslist of objectsOptional

current_stagestring or nullOptionalformat: "uuid"

The application's current stage.

reject_reasonstring or nullOptionalformat: "uuid"

The application's reason for rejection.

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	client.ats.applications.change_stage_create(
8	id="id",
9	)

1	{
2	"model": {
3	"id": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
4	"remote_id": "98796",
5	"created_at": "2021-09-15T00:00:00Z",
6	"modified_at": "2021-10-16T00:00:00Z",
7	"candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
8	"job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
9	"applied_at": "2021-10-15T00:00:00Z",
10	"rejected_at": "2021-11-15T00:00:00Z",
11	"offers": [
12	"e9b5c11d-c588-468e-8567-cd6992e42b62"
13	],
14	"source": "Campus recruiting event",
15	"credited_to": "58166795-8d68-4b30-9bfb-bfd402479484",
16	"screening_question_answers": [
17	{
18	"question": "0238cbc6-6040-430a-848e-aaiehfhdbadf4ae",
19	"answer": "5+ years experience"
20	},
21	{
22	"question": "59982bf6-7c54-4ff8-ab60-ced0bb644b84",
23	"answer": "New york city"
24	}
25	],
26	"current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea",
27	"reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784",
28	"remote_was_deleted": true,
29	"field_mappings": {
30	"organization_defined_targets": {
31	"custom_key": "custom_value"
32	},
33	"linked_account_defined_targets": {
34	"custom_key": "custom_value"
35	}
36	},
37	"remote_data": [
38	{
39	"path": "/candidacies"
40	}
41	]
42	},
43	"warnings": [
44	{
45	"title": "Unrecognized Field",
46	"detail": "An unrecognized field, age, was passed in with request data.",
47	"problem_type": "UNRECOGNIZED_FIELD",
48	"source": {
49	"pointer": "/age"
50	},
51	"block_merge_link": true
52	}
53	],
54	"errors": [
55	{
56	"title": "Missing Required Field",
57	"detail": "custom_fields is a required field on model.",
58	"problem_type": "MISSING_REQUIRED_FIELD",
59	"source": {
60	"pointer": "/model/custom_fields"
61	},
62	"block_merge_link": true
63	}
64	],
65	"logs": [
66	{
67	"log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
68	"dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
69	"log_summary": {
70	"url": "www.exampleintegration.com/api/v1/exampleapi",
71	"method": "POST",
72	"status_code": 200
73	}
74	}
75	]
76	}

/applications/{id}/change-stage

Authentication

Path parameters

Headers

Query parameters

Request

Response

Description

Usage Example

Field support by integration

Description

Usage Example

Field support by integration