Skip to main content
PATCH
Requires version 2.0.0 or later of the Archetype platform.

Overview

This endpoint changes a project’s name, its description, or both. Fields you leave out keep their value, and a body with only the project ID specified changes nothing.

Request

string
required
Project prj_ ID.
string
New display name, under the same rules as at creation: at most 128 characters once leading and trailing whitespace is dropped, not blank, and different, ignoring case, from the names of the creator’s other projects.
string
New description, at most 512 characters. An empty string clears it.

Response

Returns 200 OK with the updated project.
string
required
The project’s prj_ id.
string
required
Display name.
string
required
Description; empty when none was given.
string
required
Who created the project: a user’s usr_ id, or the key_ id of the service-account API key it was created with. Never changes.
string
required
When the project was created (date-time).
string
required
When the project’s name or description last changed (date-time); its creation time until then.

Important Notes

  • 400 means name is blank or too long, or description is too long.
  • 403 means the caller has the read-only viewer role.
  • 404 means the project does not exist or is not visible to you.
  • 409 means the project’s creator already has another project of the new name, ignoring case.