Skip to main content
PATCH
/
v4
/
studio-projects
/
{studio_project_id}
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const studioProject = await client.studioProjects.update('studio_project_id');

console.log(studioProject.id);
{
  "name": "<string>",
  "description": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
studio_project_id
string
required

Body

application/json
​
name
string

The name of the Studio Project

​
description
string

The description of the Studio Project

​
studio_api_key
string

Your API key for Studio, can be updated with the PATCH endpoint

Response

Successful Response

​
name
string
required

The name of the Studio Project

​
description
string
required

The description of the Studio Project

​
id
string
required

The unique identifier of the entity.

​
created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

​
account_id
string
required

The ID of the account that owns the given entity.

​
created_by_user_id
string
required

The user who originally created the entity.

​
created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account