Skip to content
campaiDeveloper
campai.com

Misc · Drive

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

Replace image

Replaces an organization's stored image file with an uploaded image and deletes the previous one. Provide the file ID, name, dimensions, file resource, and nullable thumbnail resource. The endpoint returns no content.

Permissions

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

Who may call it

  • Callers need organization access and the drive.edit permission.
  • Callers with assigned-only drive access may work only on files inside folders shared with them.

Request

Path parameters

  • organizationIdidrequired
  • fileIdidrequired

Body

Content-Type: application/json

  • namestringrequired

    1–128 characters

  • widthintegerrequirednullable
  • heightintegerrequirednullable
  • fileobjectrequired
    2 properties
    • fileNamestring

      at most 128 characters

    • resourcestringrequired
  • thumbnailobjectrequirednullable
    2 properties
    • fileNamestring

      at most 128 characters

    • resourcestringrequired
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/replace' \
  --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

  • Updates the file's name, width, height, file, and thumbnail.
  • If the file has a folder, updates contentUpdatedAt on that folder and its ancestors.
  • After the update, cleans up replaced storage resources.
  • If the storage limit is exceeded, removes newly stored replacement resources before refusing the request.
  • Updates cached drive storage usage by the change in stored bytes.

Errors

Other errors

StatusErrorWhen
400Only image files can be replaced this wayIf the existing file or the replacement name is not an image, the endpoint returns HTTP 400 with routes.misc.drive.notAnImage.
403You can only work inside folders shared with youIf assigned-only drive access does not allow work on the file's folder, the endpoint returns HTTP 403 with misc.drive.sharedFoldersOnly.
404The file was not foundIf the file is not found, the endpoint returns HTTP 404 with routes.misc.drive.noFile.

Errors nearly every request can meet are listed under Errors.