Rename a Design
Change the name of one design. Any design GET /designs lists can be renamed.
PUT/designs/{designId}/nameAPI Reference
Sample request
bash
curl -X PUT \
-H "x-api-key: {YOUR-API-KEY}" \
-H "Content-Type: application/json" \
-d '{"name": "Summer sale"}' \
https://api.abyssale.com/designs/64238d01-d402-474b-8c2d-fbc957e9d290/nameRequest body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The new name, 1 to 100 characters once trimmed. A name of spaces only is refused. |
Sending the name the design already has succeeds and changes nothing. Design names need not be unique: two designs can share one, in the same project or not.
Response
| Field | Type | Description |
|---|---|---|
id | string (uuid) | The design's id. |
name | string | The name as stored, trimmed. |
json
{
"id": "64238d01-d402-474b-8c2d-fbc957e9d290",
"name": "Summer sale",
"version": "v2026-10-20"
}Errors
| Status | id | When |
|---|---|---|
400 | missing_required | name is absent. |
400 | out_of_range | name is empty, spaces only, or over 100 characters once trimmed. |
404 | template_not_found | No design GET /designs lists has this id — see below. |
json
{
"id": "out_of_range",
"message": "name: Length must be between 1 and 100.",
"errors": [
{ "path": "name", "code": "out_of_range", "message": "Length must be between 1 and 100." }
]
}Which designs can be renamed
Exactly the designs GET /designs lists. Anything else answers 404 template_not_found, the same as an id that never existed:
- a design that is already deleted;
- a design in a deleted project;
- a workspace template;
- another workspace's design.
A designId that is not a UUID does not match the route and answers 404 endpoint_not_found.
Related
- Move a Design — put a design in another project
- Delete a Design — remove a design for good
- List Designs — find a design's id
