Rename a document

POSThttp://localhost:4000/api/properties/renamePropertyFileName

Changes the name of a document on a property.

Your API key needs the properties.MANAGE permission.

Body Params

idintegerrequired

ID of the property.

folderenumrequired

fileIdintegerrequired

newNamestringrequired

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/properties/renamePropertyFileName \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"id":310,"folder":"BROCHURES","fileId":901,"newName":"Summer brochure.pdf"}'

Response

Click Try It! to send a request and see the response here, or choose an example: