Skip to main content
PATCH
/
resume
/
{resume_id}
/
project
/
{id}
/
Update a project
curl --request PATCH \
  --url https://api.letraz.app/api/v1/resume/{resume_id}/project/{id}/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "category": "<string>",
  "name": "<string>",
  "description": "<string>",
  "role": "<string>",
  "github_url": "<string>",
  "live_url": "<string>",
  "started_from_month": 6,
  "started_from_year": 2000,
  "finished_at_month": 6,
  "finished_at_year": 2000,
  "current": true,
  "user": "<string>",
  "resume_section": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "skills_used": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'
{
  "id": "<string>",
  "skills_used": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category": "<string>",
      "name": "<string>",
      "preferred": true,
      "alias": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "category": "<string>",
          "name": "<string>",
          "preferred": true,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "resume_section": "<string>",
  "category": "<string>",
  "name": "<string>",
  "description": "<string>",
  "role": "<string>",
  "github_url": "<string>",
  "live_url": "<string>",
  "started_from_month": 6,
  "started_from_year": 2000,
  "finished_at_month": 6,
  "finished_at_year": 2000,
  "current": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

ID of the project that you want to update

​
resume_id
string
required

Resume ID of the resume the education belongs to. If you want to interact with the base project, just put base in here

Body

​
category
string | null

Category or type of the project (e.g., Web Development, Mobile App).

Maximum length: 255
​
name
string

Name of the project.

Maximum length: 255
​
description
string | null

Detailed description of the project and its objectives.

​
role
string | null

Your role or position in this project (e.g., Lead Developer, UI Designer).

Maximum length: 255
​
github_url
string<uri> | null

Link to the project's GitHub repository.

Maximum length: 200
​
live_url
string<uri> | null

Link to the live/deployed version of the project.

Maximum length: 200
​
started_from_month
integer | null

Month when the project started (1-12).

Required range: 1 <= x <= 12
​
started_from_year
integer | null

Year when the project started (YYYY).

Required range: 1900 <= x <= 2100
​
finished_at_month
integer | null

Month when the project was completed (1-12).

Required range: 1 <= x <= 12
​
finished_at_year
integer | null

Year when the project was completed (YYYY).

Required range: 1900 <= x <= 2100
​
current
boolean | null

Indicates if this is a current/ongoing project.

​
user
string

The user who owns this project

​
resume_section
string<uuid>

The unique identifier for the resume section entry.

​
skills_used
string<uuid>[]

Technical skills and technologies used in this project.

Response

​
id
string
required
​
skills_used
object[]
required
​
resume_section
string
required
​
name
string
required

Name of the project.

Maximum length: 255
​
created_at
string<date-time>
required

Timestamp when the project was first created.

​
updated_at
string<date-time>
required

Timestamp when the project was last updated.

​
user
string
required

The user who owns this project

​
category
string | null

Category or type of the project (e.g., Web Development, Mobile App).

Maximum length: 255
​
description
string | null

Detailed description of the project and its objectives.

​
role
string | null

Your role or position in this project (e.g., Lead Developer, UI Designer).

Maximum length: 255
​
github_url
string<uri> | null

Link to the project's GitHub repository.

Maximum length: 200
​
live_url
string<uri> | null

Link to the live/deployed version of the project.

Maximum length: 200
​
started_from_month
integer | null

Month when the project started (1-12).

Required range: 1 <= x <= 12
​
started_from_year
integer | null

Year when the project started (YYYY).

Required range: 1900 <= x <= 2100
​
finished_at_month
integer | null

Month when the project was completed (1-12).

Required range: 1 <= x <= 12
​
finished_at_year
integer | null

Year when the project was completed (YYYY).

Required range: 1900 <= x <= 2100
​
current
boolean | null

Indicates if this is a current/ongoing project.