put/coverletter/{coverLetterId}
Candidates have the option of edit cover letters to attach to job offer applications that required them. This operation will edit an existing cover letter on the authenticated user and identified by the coverletter id informed.
Request
Resource URL
https://api.infojobs.net/api/2/coverletter/{coverLetterId}
Security
- User Role: role_candidate
- Scope: cover_letter_write
Parameters
Body Request Fields
{
"name": "Presentación",
"text": "Some text, some text, some more text ...",
"main": true
}
| Field Name | Description |
|---|---|
|
key String Requited |
Path param text key identifying the cover letter to edit. Example values: 70628530-6d45-483a-8327-d8c81b0a62ab |
|
name String Required |
The name with wich the cover letter was saved. Maximum lenght: 100 If this field is not informedis invalid an exception will be thrown. Example values: some-name |
|
text String Required |
The cover letter text. If this field is not informedes invalid an exception will be thrown. The cover letter in text format to be edited. It must be in "UTF-8" format. IMPORTANT: Please note in compliance with JSON format you must not send carriage returns within the value field, but replace them with "\n" instead. Example values: Some text some text. Some more text. |
|
main Boolean Optional |
True if the cover letter is the default chosen by the authenticated user to apply to job offers, false otherwise. Defaul value: false. |
Response
Response fields
| Name | Description |
|---|---|
|
name String |
The name with wich the cover letter was saved. Maximum lenght: 100 |
|
key String |
The cover letter identifier Maximum lenght: 100 |
|
text String |
The cover letter text. |
|
main Boolean |
True if the cover letter is the default chosen by the authenticated user to apply to job offers, false otherwise. |
Error Codes
| Code | Description |
|---|---|
|
341 |
The coverletter text is invalid, it should be less than 4000 characters long. |
|
741 |
The value of name is mandatory. |
|
742 |
The value of text is mandatory. |
|
743 |
There is no cover letter with key , use a valid existing key for updating or do not send a key in order to create the cover letter as a new one. |
Examples
This example updates the cover letter with the field values informed by the user.
Request
PUT https://api.infojobs.net/api/2/coverletter/8c1e03cf-080a-4fcb-a2e3-6b2daa3aa013
{
"name": "Presentación",
"text": "Some text, some text, some more text ...",
"main": true
}
Response
{
"name": "Presentación",
"key": "8c1e03cf-080a-4fcb-a2e3-6b2daa3aa013",
"text": "Some text, some text, some more text ...",
"main": true
}
