Patch resume data
curl --request PATCH \
--url http://localhost:3000/api/openapi/resumes/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"operations": [
{
"op": "<unknown>",
"path": "<string>",
"value": "<unknown>"
}
],
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://localhost:3000/api/openapi/resumes/{id}"
payload = {
"operations": [
{
"op": "<unknown>",
"path": "<string>",
"value": "<unknown>"
}
],
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
operations: [{op: '<unknown>', path: '<string>', value: '<unknown>'}],
expectedUpdatedAt: '2023-11-07T05:31:56Z'
})
};
fetch('http://localhost:3000/api/openapi/resumes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/resumes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'operations' => [
[
'op' => '<unknown>',
'path' => '<string>',
'value' => '<unknown>'
]
],
'expectedUpdatedAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/openapi/resumes/{id}"
payload := strings.NewReader("{\n \"operations\": [\n {\n \"op\": \"<unknown>\",\n \"path\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:3000/api/openapi/resumes/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"operations\": [\n {\n \"op\": \"<unknown>\",\n \"path\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/resumes/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"operations\": [\n {\n \"op\": \"<unknown>\",\n \"path\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"tags": [
"<string>"
],
"isPublic": true,
"isLocked": true,
"data": {
"picture": {
"hidden": true,
"url": "<string>",
"size": 272,
"rotation": 180,
"aspectRatio": 1.5,
"borderRadius": 50,
"borderColor": "<string>",
"borderWidth": 1,
"shadowColor": "<string>",
"shadowWidth": 1
},
"basics": {
"name": "<string>",
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"location": "<string>",
"website": {
"url": "<string>",
"label": "<string>"
},
"customFields": [
{
"id": "<string>",
"icon": "<string>",
"text": "<string>",
"link": "<string>"
}
]
},
"summary": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"content": "<string>"
},
"sections": {
"profiles": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"network": "<string>",
"username": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
}
}
]
},
"experience": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"company": "<string>",
"position": "<string>",
"location": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>",
"roles": [
{
"id": "<string>",
"position": "<string>",
"period": "<string>",
"description": "<string>"
}
]
}
]
},
"education": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"school": "<string>",
"degree": "<string>",
"area": "<string>",
"grade": "<string>",
"location": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"projects": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"name": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"skills": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"name": "<string>",
"proficiency": "<string>",
"level": 2.5,
"keywords": [
"<string>"
]
}
]
},
"languages": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"language": "<string>",
"fluency": "<string>",
"level": 2.5
}
]
},
"interests": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"name": "<string>",
"keywords": [
"<string>"
]
}
]
},
"awards": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"awarder": "<string>",
"date": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"certifications": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"issuer": "<string>",
"date": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"publications": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"publisher": "<string>",
"date": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"volunteer": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"organization": "<string>",
"location": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"references": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"name": "<string>",
"position": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"phone": "<string>",
"description": "<string>"
}
]
}
},
"customSections": [
{
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"id": "<string>",
"items": [
{
"id": "<string>",
"hidden": true,
"recipient": "<string>",
"content": "<string>"
}
]
}
],
"metadata": {
"layout": {
"sidebarWidth": 30,
"pages": [
{
"fullWidth": true,
"main": [
"<string>"
],
"sidebar": [
"<string>"
]
}
]
},
"page": {
"gapX": 1,
"gapY": 1,
"marginX": 1,
"marginY": 1,
"locale": "<string>",
"hideLinkUnderline": true,
"hideIcons": true,
"hideSectionIcons": true
},
"design": {
"level": {
"icon": "<string>"
},
"colors": {
"primary": "<string>",
"text": "<string>",
"background": "<string>"
}
},
"typography": {
"body": {
"fontFamily": "<string>",
"fontWeights": [],
"fontSize": 15,
"lineHeight": 2.25
},
"heading": {
"fontFamily": "<string>",
"fontWeights": [],
"fontSize": 15,
"lineHeight": 2.25
}
},
"notes": "<string>",
"styleRules": [
{
"id": "<string>",
"label": "<string>",
"enabled": true,
"target": {
"scope": "<unknown>"
},
"slots": {}
}
]
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"hasPassword": true
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The patch operations are invalid or produced an invalid resume.",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The resume changed after this patch was generated.",
"data": "<unknown>"
}Resumes
Patch resume data
Applies JSON Patch (RFC 6902) operations to partially update a resume’s data. This allows small, targeted changes (e.g. updating a single field) without sending the entire resume object. Locked resumes cannot be patched. Requires authentication.
PATCH
/
resumes
/
{id}
Patch resume data
curl --request PATCH \
--url http://localhost:3000/api/openapi/resumes/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"operations": [
{
"op": "<unknown>",
"path": "<string>",
"value": "<unknown>"
}
],
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://localhost:3000/api/openapi/resumes/{id}"
payload = {
"operations": [
{
"op": "<unknown>",
"path": "<string>",
"value": "<unknown>"
}
],
"expectedUpdatedAt": "2023-11-07T05:31:56Z"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
operations: [{op: '<unknown>', path: '<string>', value: '<unknown>'}],
expectedUpdatedAt: '2023-11-07T05:31:56Z'
})
};
fetch('http://localhost:3000/api/openapi/resumes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/resumes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'operations' => [
[
'op' => '<unknown>',
'path' => '<string>',
'value' => '<unknown>'
]
],
'expectedUpdatedAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/openapi/resumes/{id}"
payload := strings.NewReader("{\n \"operations\": [\n {\n \"op\": \"<unknown>\",\n \"path\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:3000/api/openapi/resumes/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"operations\": [\n {\n \"op\": \"<unknown>\",\n \"path\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/resumes/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"operations\": [\n {\n \"op\": \"<unknown>\",\n \"path\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"tags": [
"<string>"
],
"isPublic": true,
"isLocked": true,
"data": {
"picture": {
"hidden": true,
"url": "<string>",
"size": 272,
"rotation": 180,
"aspectRatio": 1.5,
"borderRadius": 50,
"borderColor": "<string>",
"borderWidth": 1,
"shadowColor": "<string>",
"shadowWidth": 1
},
"basics": {
"name": "<string>",
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"location": "<string>",
"website": {
"url": "<string>",
"label": "<string>"
},
"customFields": [
{
"id": "<string>",
"icon": "<string>",
"text": "<string>",
"link": "<string>"
}
]
},
"summary": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"content": "<string>"
},
"sections": {
"profiles": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"network": "<string>",
"username": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
}
}
]
},
"experience": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"company": "<string>",
"position": "<string>",
"location": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>",
"roles": [
{
"id": "<string>",
"position": "<string>",
"period": "<string>",
"description": "<string>"
}
]
}
]
},
"education": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"school": "<string>",
"degree": "<string>",
"area": "<string>",
"grade": "<string>",
"location": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"projects": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"name": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"skills": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"name": "<string>",
"proficiency": "<string>",
"level": 2.5,
"keywords": [
"<string>"
]
}
]
},
"languages": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"language": "<string>",
"fluency": "<string>",
"level": 2.5
}
]
},
"interests": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"name": "<string>",
"keywords": [
"<string>"
]
}
]
},
"awards": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"awarder": "<string>",
"date": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"certifications": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"issuer": "<string>",
"date": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"publications": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"publisher": "<string>",
"date": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"volunteer": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"organization": "<string>",
"location": "<string>",
"period": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"references": {
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"name": "<string>",
"position": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"phone": "<string>",
"description": "<string>"
}
]
}
},
"customSections": [
{
"title": "<string>",
"icon": "<string>",
"columns": 3,
"hidden": true,
"keepTogether": true,
"startOnNewPage": true,
"id": "<string>",
"items": [
{
"id": "<string>",
"hidden": true,
"recipient": "<string>",
"content": "<string>"
}
]
}
],
"metadata": {
"layout": {
"sidebarWidth": 30,
"pages": [
{
"fullWidth": true,
"main": [
"<string>"
],
"sidebar": [
"<string>"
]
}
]
},
"page": {
"gapX": 1,
"gapY": 1,
"marginX": 1,
"marginY": 1,
"locale": "<string>",
"hideLinkUnderline": true,
"hideIcons": true,
"hideSectionIcons": true
},
"design": {
"level": {
"icon": "<string>"
},
"colors": {
"primary": "<string>",
"text": "<string>",
"background": "<string>"
}
},
"typography": {
"body": {
"fontFamily": "<string>",
"fontWeights": [],
"fontSize": 15,
"lineHeight": 2.25
},
"heading": {
"fontFamily": "<string>",
"fontWeights": [],
"fontSize": 15,
"lineHeight": 2.25
}
},
"notes": "<string>",
"styleRules": [
{
"id": "<string>",
"label": "<string>",
"enabled": true,
"target": {
"scope": "<unknown>"
},
"slots": {}
}
]
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"hasPassword": true
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The patch operations are invalid or produced an invalid resume.",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The resume changed after this patch was generated.",
"data": "<unknown>"
}Authorizations
The API key to authenticate requests.
Path Parameters
The ID of the resume to patch.
Body
application/json
An array of JSON Patch (RFC 6902) operations to apply to the resume data.
Minimum array length:
1- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
If provided, the patch only applies when the resume version still matches this timestamp.
Response
The patched resume with its full data.
The ID of the resume.
The name of the resume.
Minimum string length:
1The slug of the resume.
Minimum string length:
1The tags of the resume.
Whether the resume is public.
Whether the resume is locked.
Show child attributes
Show child attributes
The date and time the resume was last updated.
⌘I