PUT
/
api
/
v1
/
projects
/
{projectId}
curl --request PUT \
  --url https://api.us.vartiq.com/api/v1/projects/{projectId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "company": "<string>",
    "environment": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

URL Parameters

projectId
string
required

The unique identifier of the project to update

Body Parameters

name
string

The new name for the project

description
string

The new description for the project

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The updated project object

Response Example

{
  "success": true,
  "message": "Project updated successfully",
  "data": {
    "id": "proj_01JWB8YZNBQDJA3VZ3F8Z9C5NX",
    "name": "Updated project",
    "company": "6836eb8d404feca42c262a86",
    "environment": "development",
    "createdAt": "2025-05-28T11:03:12.308Z",
    "updatedAt": "2025-06-05T07:56:00.111Z"
  }
}
PUT
/
api
/
v1
/
projects
/
{projectId}
curl --request PUT \
  --url https://api.us.vartiq.com/api/v1/projects/{projectId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "company": "<string>",
    "environment": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

URL Parameters

projectId
string
required

The unique identifier of the project to update

Body Parameters

name
string

The new name for the project

description
string

The new description for the project

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The updated project object

Response Example

{
  "success": true,
  "message": "Project updated successfully",
  "data": {
    "id": "proj_01JWB8YZNBQDJA3VZ3F8Z9C5NX",
    "name": "Updated project",
    "company": "6836eb8d404feca42c262a86",
    "environment": "development",
    "createdAt": "2025-05-28T11:03:12.308Z",
    "updatedAt": "2025-06-05T07:56:00.111Z"
  }
}