Projects (Deprecated)

Update Project

<strong>Deprecated.</strong> Use the <code>Update Project</code> endpoint under Organization instead.

Updates the specified Project.

A Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.

put/projects/{projectId}

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/projects/{projectId}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the Project

Request body

namestring required

Project name

descriptionstring

Descriptive text about the project

Example request

{
  "name": "My Project",
  "description": "This is a project that does something"
}

Response

Project updated

idstring

Project ID

namestring

Project name

descriptionstring

Descriptive text about the project

domainstring

Domain of the project

webhookBaseUrlstring

Webhook base URL

createdAtstring

The date and time the project was created

ownerstring

The owner of the project

workspaceIdstring

The workspace to which the project belongs

Changes

No recorded changes to this operation across all 1 revision of this API.