Rename an artifact

Owner only. Changes the library name and leaves the HTML object, content revision, access, organization, and share columns unchanged. The creator is the only caller who can rename. Organization role is not consulted, so an organization admin who did not create the artifact cannot rename it. A missing id and a caller who is not the creator, including a member who can read an org_shared artifact, return the same 404 as an unknown id. Cookie-authenticated writes need an allowed Origin.

PATCH /api/v1/artifacts/{id}/name

200

{
  "artifact": {
    "id": "11111111-1111-4111-8111-111111111111",
    "creatorUserId": "user_example",
    "organizationId": null,
    "accessType": "private",
    "filename": "11111111-1111-4111-8111-111111111111.html",
    "name": "Launch notes",
    "mimeType": "text/html",
    "sizeBytes": 527,
    "createdAt": "2026-10-21T12:00:00.000Z",
    "updatedAt": "2026-10-21T12:00:00.000Z",
    "uploadedAt": "2026-10-21T12:00:00.000Z",
    "viewerUrl": "http://localhost:3000/artifacts/11111111-1111-4111-8111-111111111111",
    "contentUrl": "http://localhost:3001/api/v1/artifacts/11111111-1111-4111-8111-111111111111/content",
    "shared": false,
    "passwordProtected": false
  }
}

Authorizations

bearerAuthsessionCookie

Authorization · string · header · required

Factrove API key, usually prefixed ftrv_. Send Authorization: Bearer <key>. Product routes do not accept x-api-key as a credential. A present Authorization header that is not a valid key does not fall back to the session cookie.

Path Parameters

id · string<uuid> · required

Artifact UUID.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

The new library name. This route does not change access or content, and it cannot clear a name.

name · string · required

Response

200

application/json

The same artifact with the new name.

artifact · object · required

Show child attributes