Skip to main content
PATCH
/
{slug}
/
projects
/
{project_id}
Update project
curl --request PATCH \
  --url https://api.dimred.com/api/v2/{slug}/projects/{project_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "project_name": "<string>",
  "project_description": "<string>",
  "project_type": "DEVELOPMENT",
  "is_pinned": true
}'
{
  "project_id": "<string>",
  "org_id": "<string>",
  "project_name": "<string>",
  "project_description": "<string>",
  "project_type": "<string>",
  "is_pinned": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

slug
string
required

Organization slug

project_id
string
required

Project ID

Body

application/json
project_name
string

Name of the project

project_description
string

Description of the project

project_type
enum<string>

Type of the project

Available options:
DEVELOPMENT,
PRODUCTION,
TESTING
is_pinned
boolean

Whether the project is pinned

Response

200 - application/json

Project updated successfully

project_id
string
required

Unique identifier for the project

org_id
string
required

Identifier of the organization the project belongs to

project_name
string
required

Name of the project

project_type
string
required

Type of the project

is_pinned
boolean
required

Whether the project is pinned

created_at
string<date-time>
required

Timestamp when the project was created

project_description
string

Description of the project

I