Update Application
PUT /services/api/v1/applications/{id}
Updates an existing application.
Parameters
Parameter | Type | Description |
---|---|---|
id | string | The ID of the application. |
Request Body
- Example
- Schema
{
"application_status_id": "nyBnKYM3",
"email": "john.doe@privatemail.com",
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"birthday": "2000-01-31",
"phone": "+39 1234567890",
"cf_12345": null,
"cf_54321": null
}
Attribute | Type | Required | Description |
---|---|---|---|
application_status_id | string | false | Application status id. By default the status will be set to the default unanswered status of the business. |
accept_terms_and_conditions | boolean | true | Boolean indicating if terms and conditions have been accepted. Needs to be true in order to create an application. |
accept_archivation | boolean | false | Boolean indicating if applicant accepted archivation. |
language | string | false | Preferred communication language of the applicant. Can only be a value of the supported business languages |
Note that the fields above are only the fixed fields. All custom fields are provided by the Application Fields API endpoint.
Response
The updated employee.
- Example
- Schema
{
"id": "A96ey16n",
"job_id": "Oxz0W6kK",
"application_status_id": "nyBnKYM3",
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"email": "john.doe@privatemail.com",
"phone": "+39 1234567890",
"birthday": "2000-01-31",
"cf_10": null,
"created_at": "2024-09-03T20:37:36.000Z",
"updated_at": "2024-09-06T05:58:55.860Z"
}
Attribute | Type | Required | Description |
---|---|---|---|
id | string | readonly | Application id. |
job_id | string | readonly | Job id of the job opening the application belongs to. |
created_at | string | readonly | Application creation date. |
updated_at | string | readonly | Application last updated at. |
application_status_id | string | false | Application status id. By default the status will be set to the default unanswered status of the business. |
accept_terms_and_conditions | boolean | true | Boolean indicating if terms and conditions have been accepted. Needs to be true in order to create an application. |
accept_archivation | boolean | false | Boolean indicating if applicant accepted archivation. |
language | string | false | Preferred communication language of the applicant. Can only be a value of the supported business languages |
Note that the fields above are only the fixed fields. All custom fields are provided by the Application Fields API endpoint.
Unprocessable Entitiy.
Example:
{
"email": ["This field is mandatory."],
"birthday": ["This field is invalid."]
}