Changes the name, description, icon or colour of a project. Send only what changes.
HTTP
PATCH /projects/{projectId}Access: Session token only. API keys get 403 with insufficient_scope.
Role: Project manager (organisation owners and admins are managers of every project).
Path parameters #
| Parameter | Description |
|---|---|
projectId | The id of the project. |
Request body #
JSON.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | At most 80 characters. Cannot be empty. |
description | string | no | At most 400 characters. May be empty. |
icon | string | no | At most 16 characters. |
accent | string | no | A colour in the form #rrggbb. |
type | string or null | no | game, mobile, web, ecommerce or other. null removes the type. |
JSON
{ "name": "Web shop", "accent": "#06b6d4" }Response 200 #
The project after the change.
JSON
{
"id": "0197a3c6-4d53-7a44-87fb-9b3e5c0a2d64",
"name": "Shop",
"description": "The web shop",
"icon": null,
"accent": "#7c3aed",
"type": "web",
"status": "active",
"sourceLanguage": "en-gb",
"targetLanguages": ["de-de", "fr-fr"],
"progress": 42,
"keys": 318,
"members": [{ "initials": "AL", "from": "#06b6d4", "to": "#7c3aed" }],
"extraMembers": 0,
"ageMinutes": 15
}Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the project. |
name | string | The name. |
description | string | The description. |
icon | string or null | An emoji. The app shows an abbreviation of the name instead. |
accent | string | A colour such as #7c3aed. |
type | string or null | What the project is translated for: game, mobile, web, ecommerce or other. null when none was given. |
status | string | active or archived. |
sourceLanguage | string | The language code of the source text. |
targetLanguages | list of string | The language codes of every language of the project, whatever its status. |
progress | integer | Percent of keys on the protected branch that are published, across all languages. |
keys | integer | Number of keys on the protected branch. |
members | list of object | Up to 3 people with access, as initials, from and to for an avatar. |
extraMembers | integer | How many more people have access. |
ageMinutes | integer | Minutes since the project last changed. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The project does not exist in your organisation, you have no access to it, or projectId is not a UUID. |
| 403 | forbidden | You are a member of the project, but not a manager. |
| 422 | invalid_request | A value is empty, too long, accent is not a colour like #06b6d4, or type is not one of the listed values. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.