Skip to main content
PUT
/
room
/
:room_id
/
document
/
:document_id
/
rename
Rename Document
curl --request PUT \
  --url https://api.example.com/room/:room_id/document/:document_id/rename \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_document_name": "<string>"
}
'
{
  "status": 123
}
Renames an existing document in a room.

​
Authentication

No authentication required.

​
Path Parameters

​
room_id
string
required
The unique identifier of the room containing the document.
​
document_id
string
required
The unique identifier of the document to rename.

​
Body Parameters

​
new_document_name
string
required
The new name for the document.

​
Response

​
status
number
Returns 200 on successful document rename.

​
Error Responses

  • 500 - Internal server error occurred while renaming the document.

​
Example Request

curl -X PUT \
  https://api.planttogether.com/room/abc123/document/doc456/rename \
  -H "Content-Type: application/json" \
  -d '{
    "new_document_name": "updated-document-name"
  }'

​
Example Response

200 OK

Build docs developers (and LLMs) love

Get started for freeTalk to us