Skip to main content
PUT
/
projects
/
{projectId}
Update Project
curl --request PUT \
  --url https://partner.peaka.studio/api/v1/projects/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Project Name",
  "description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis."
}
'
{
  "id": "URNg0GIj",
  "name": "Updated Project Name",
  "description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis.",
  "domain": "sampleprojectname-cdcn",
  "webhookBaseUrl": null,
  "createdAt": "2024-09-10T10:11:02.385253956Z"
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the Project

Body

application/json

Project to update

​
name
string
required

Project name

Example:

"My Project"

​
description
string

Descriptive text about the project

Example:

"This is a project that does something"

Response

200 - application/json

Project updated

Project

​
id
string

Project ID

​
name
string

Project name

​
description
string

Descriptive text about the project

​
domain
string

Domain of the project

​
webhookBaseUrl
string

Webhook base URL

​
createdAt
string

The date and time the project was created

​
owner
string

The owner of the project

​
workspaceId
string

The workspace to which the project belongs