Update Project by ID

Update a Project in your workspace

Path Params
string
required

The Project's unique ID

Body Params
string

The ID of the user updating the project

string

The name of the project

string
enum

Who can access the project. PRIVATE restricts access to the owning user (plus anyone explicitly shared in); WORKSPACE shares the project with every member of the calling workspace. Omit to leave the current access level unchanged.

Allowed:
settings
object

Updated default settings for the project (goal, brand voice, audience, style, knowledge). Omit a field to leave it unchanged.

metadata
object

An optional set of key-value pairs to attach any data you wish to the project, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long. Provided string values upsert that key; pass null for a key to remove it; omit this field entirely to leave the existing metadata unchanged.

Responses

400

Bad request. May be missing required inputs or may have badly formatted inputs.

401

Unauthorized access to the workspace.

404

Not found. May have an incorrect URL path.

500

Internal server error. Unable to update project.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json