Withdraw an application

POST

https://api.confirm.global/api/v1/applications/:applicationId/withdraw

POST

/api/v1/applications/:applicationId/withdraw

$ curl -X POST https://api.confirm.global/api/v1/applications/applicationId/withdraw \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "application_id": "string",
3   "org_id": "string",
4   "candidate_id": "string",
5   "job_id": "string",
6   "status": "applied",
7   "score": 1.1,
8   "applied_at": "2024-01-15T09:30:00Z",
9   "evaluation_status": "string",
10   "evaluation_sent_at": "2024-01-15T09:30:00Z",
11   "evaluation_completed_at": "2024-01-15T09:30:00Z",
12   "candidates": {
13     "candidate_id": "string",
14     "org_id": "string",
15     "first_name": "string",
16     "last_name": "string",
17     "email": "string",
18     "phone": "string",
19     "address_line1": "string",
20     "address_line2": "string",
21     "city": "string",
22     "state": "string",
23     "postal_code": "string",
24     "country": "string",
25     "source": "string",
26     "applications": [
27       {
28         "application_id": "string",
29         "org_id": "string",
30         "candidate_id": "string",
31         "job_id": "string",
32         "status": "applied",
33         "score": 1.1,
34         "applied_at": "2024-01-15T09:30:00Z",
35         "evaluation_status": "string",
36         "evaluation_sent_at": "2024-01-15T09:30:00Z",
37         "evaluation_completed_at": "2024-01-15T09:30:00Z",
38         "created_at": "2024-01-15T09:30:00Z",
39         "updated_at": "2024-01-15T09:30:00Z"
40       }
41     ],
42     "created_at": "2024-01-15T09:30:00Z",
43     "updated_at": "2024-01-15T09:30:00Z"
44   },
45   "created_at": "2024-01-15T09:30:00Z",
46   "updated_at": "2024-01-15T09:30:00Z"
47 }

Marks the application as withdrawn by the candidate.

Authentication

AuthorizationBearer

Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

Path parameters

applicationIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

reasonstringOptional

Response

The withdrawn application.

application_idstringOptionalformat: "uuid"

org_idstringOptionalformat: "uuid"

candidate_idstringOptionalformat: "uuid"

job_idstringOptionalformat: "uuid"

statusenumOptional

Pipeline stage slug (candidate lifecycle v4).

scoredouble or nullOptional

Screening score, when available.

applied_atdatetime or nullOptional

evaluation_statusstring or nullOptional

evaluation_sent_atdatetime or nullOptional

evaluation_completed_atdatetime or nullOptional

candidatesobjectOptional

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error