v0.4 GitHub apistock.dev

API reference/Projects

Update a project

PATCH /v1/orgs/{orgId}/projects/{id}

Send the fields to change and the version you read.

Authorization

bearer

Authorizationheader · stringrequired

Session token from POST /v1/auth/login with "transport": "bearer". Browsers use the session cookie that login sets instead.

Path

orgIdstringrequired

maxLength: 64

idstringrequired

maxLength: 64

Body

application/json

versionintegerrequired

The version you read. If the project changed since, the update fails with project_version_conflict.

format: int64minimum: 1

descriptionstring

maxLength: 2000

namestring

maxLength: 100

statusstring

one of: active, archived

Responses

errors: application/problem+json

200

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

Match errors on the problem's code, which stays the same, not on its message.

Send a request

Server

Bearer token

orgId path

id path

Body

The request goes from your browser straight to this server; nothing passes through this site. The API must allow this site's origin for CORS.

Requestexample

curl -X PATCH "$API_URL/v1/orgs/$ORG_ID/projects/$ID" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "version": 1,
  "description": "string",
  "name": "string",
  "status": "active"
}'

body := strings.NewReader(`{
  "version": 1,
  "description": "string",
  "name": "string",
  "status": "active"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPatch,
	apiURL + "/v1/orgs/" + orgID + "/projects/" + id, body)
if err != nil {
	return err
}
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer res.Body.Close()

const res = await fetch(`${apiUrl}/v1/orgs/${orgId}/projects/${id}`, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "version": 1,
    "description": "string",
    "name": "string",
    "status": "active"
  }),
});
const data = await res.json();

Responseexample

{
  "created_at": "2026-09-15T12:00:00Z",
  "created_by": "usr_mfrggzdfmztwq2lkmfrggzdfmy",
  "description": "string",
  "id": "prj_mfrggzdfmztwq2lkmfrggzdfmy",
  "name": "string",
  "status": "active",
  "updated_at": "2026-09-15T12:00:00Z",
  "version": 1
}

{
  "code": "string",
  "status": 401,
  "title": "Unauthorized",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 403,
  "title": "Forbidden",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 404,
  "title": "Not Found",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 409,
  "title": "Conflict",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "string",
  "errors": [
    {
      "message": "expected length >= 1",
      "location": "body.name"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}