Skip to content
campaiDeveloper
campai.com

Misc · Drive

POST/{organizationId}/misc/drive/files/{fileId}

Rename file

Renames an organization's file using the supplied organizationId, fileId, and name, while keeping its existing extension. The name is limited to 128 characters, including any preserved extension. The endpoint returns no value.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have access to the organization and the drive.edit permission.
  • For callers with assigned-only drive access, the file must be inside a folder shared with them.

Request

Path parameters

  • organizationIdidrequired
  • fileIdidrequired

Body

Content-Type: application/json

  • namestringrequired

    1–128 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/files/YOUR_FILE_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

No response body is specified.

What else happens

  • After the access check and file lookup succeed, the endpoint updates the file's name in driveFiles.

Errors

Other errors

StatusErrorWhen
403You can only work inside folders shared with youIf a caller with assigned-only drive access tries to rename a file outside a folder shared with them, the endpoint returns 403 FORBIDDEN with key misc.drive.sharedFoldersOnly.
404The file was not foundIf the file is not found in the organization, the endpoint returns 404 NOT_FOUND with key routes.misc.drive.noFile.

Errors nearly every request can meet are listed under Errors.