---
title: "CloudObjects.update"
method: PATCH
path: "/entities/CloudObjects/{id}"
tags: ["Document"]
---

# CloudObjects.update

`PATCH /entities/CloudObjects/{id}`

Modifies CloudObject or CloudObjects with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateCloudObjectInput
  - `application_id` string, uuid — Id of the producing application.
  - `company_cloud_object_folder_id` string, uuid — Id of the company folder, or empty when the object is not stored in the company tree.
  - `creator_id` string, uuid — Id of the uploading user.
  - `filename` string — File name (with extension) used when downloading the object.
  - `is_public` boolean — When true, the object can be served via a public URL (see public_url).
  - `params` object — Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object.
  - `upload_source` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor
  - `revision` integer — Revision when entity was lastly changed.

## Response `200`

Modification confirmation. Returns resulting CloudObject

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` CloudObject
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `application` string, uri — Application that produced the object (e.g. Online Forms). Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties.
    - `company_cloud_object_folder` string, uri — Company-level folder that contains the object, when stored in the company document tree. Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties.
    - `creator` string, uri — User who uploaded the object. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `application_id` string, uuid — Id of the producing application.
    - `company_cloud_object_folder_id` string, uuid — Id of the company folder, or empty when the object is not stored in the company tree.
    - `creator_id` string, uuid — Id of the uploading user.
    - `filename` string, required — File name (with extension) used when downloading the object.
    - `is_public` boolean — When true, the object can be served via a public URL (see public_url).
    - `mime_type` string — Mime-type of the cloud object Is detected from content.
    - `params` object — Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object.
    - `size` integer, required — Size of the object in bytes.
    - `type` -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, required — Field whose values are strictly defined with an enumeration of values. Integer enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile
    - `upload_source` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor
    - `url` string — URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
    - `revision` integer — Revision when entity was lastly changed.
    - `dimensions` object — returns dimensions in case of image
    - `duration` number, double — returns duration of audio file in seconds
    - `public_url` string — returns public url for cloud object

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)