Rename

Beta: Rename a slot document

post

Update the display name of a document attached to a slot. Renames are rejected on cancelled slots. Renaming to the same name is a no-op (no history event recorded). Returns the updated document.

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

site-slugstringRequired

The slug identifier of the site

slot-uidstringRequired

The unique identifier of the slot

doc-uidstringRequired

The unique identifier of the document

Body

application/json

namestring · max: 255Required

The new display name (1 to 255 characters, trimmed).

Responses

200

Document renamed successfully

application/json

uidstringRequired

Unique identifier for the document

slot_uidstringRequired

Unique identifier of the slot the document is attached to

namestringRequired

Display name of the document

filestring · uriRequired

URL of the uploaded file

file_sizeintegerRequired

File size in bytes

createdstring · date-timeRequired

Upload timestamp in ISO 8601 format

400

Bad request. The slot_cancelled state error is returned with its named code under non_field_errors. Structural input errors (missing name, blank name, name over 255 chars) return the umbrella shape: non_field_errors with code: ["invalid_input"] and one detail entry per offending field, formatted as "<dotted-loc>: <message>" (e.g. "name: Field required").

404

Site, slot or document not found.

post

/flow/sites/{site-slug}/slots/{slot-uid}/documents/{doc-uid}/rename/

HTTPcURLJavaScriptPython

POST /api/v4/flow/sites/{site-slug}/slots/{slot-uid}/documents/{doc-uid}/rename/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "uid": "text",
  "slot_uid": "text",
  "name": "text",
  "file": "https://example.com",
  "file_size": 1,
  "created": "2026-05-13T01:01:33.020Z",
  "created_by_user": {
    "email": "text",
    "first_name": "text",
    "last_name": "text"
  }
}