--- title: "CloudObjectRelations.update" method: PATCH path: "/entities/CloudObjectRelations/{id}" tags: ["Document"] --- # CloudObjectRelations.update `PATCH /entities/CloudObjectRelations/{id}` Modifies CloudObjectRelation or CloudObjectRelations with given id(s) ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateCloudObjectRelationInput - `cloud_object` object — Cloud object (file) being linked. Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. - `id` string, uri - `report_schedule` object — Report schedule the file is attached to (e.g. an exported report). Relation to ReportSchedule, see: 'updateReportScheduleInput' object for properties. - `id` string, uri - `text_message` object — Text message (SMS/MMS) the file is attached to. Relation to TextMessage, see: 'updateTextMessageInput' object for properties. - `id` string, uri - `account_id` string, uuid — Id of the linked account. - `activity_id` string, uuid — Id of the linked appointment or task, or empty when not linked. - `approval_process_id` string, uuid — Id of the linked approval process. - `call_id` string, uuid — Id of the linked call. - `cloud_object_folder_id` string, uuid — Id of the folder within the parent record, or empty when stored at the record root. - `cloud_object_id` string, uuid — Id of the linked file. - `contact_id` string, uuid — Id of the linked contact. - `custom_entity_id` string, uuid — Id of the linked custom entity record. - `email_sequence_id` string, uuid — Id of the linked email sequence. - `email_template_id` string, uuid — Id of the linked email template. - `field_mapping_id` string, uuid — Id of the linked field mapping. - `lead_oppty_id` string, uuid — Id of the linked lead or opportunity, or empty when not linked. - `media_id` string, uuid — Id of the linked media record. - `message_id` string, uuid — Id of the linked email or memo, or empty when not linked. - `online_form_field_id` string, uuid — Id of the online form field the file was uploaded into. - `online_form_id` string, uuid — Id of the linked online form submission. - `process_id` string, uuid — Id of the linked sales process. - `process_template_id` string, uuid — Id of the linked sales process template. - `project_id` string, uuid — Id of the linked project. - `quote_id` string, uuid — Id of the linked quote. - `report_schedule_id` string, uuid — Id of the linked report schedule. - `text_message_id` string, uuid — Id of the linked text message. - `revision` integer — Revision when entity was lastly changed. ## Response `200` Modification confirmation. Returns resulting CloudObjectRelation - object - `success` boolean — True when response succeeded, false on error. - `data` CloudObjectRelation - `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. - `account` string, uri — Account the file is attached to, or empty when not attached to an account. Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. - `appointment` string, uri — Appointment the file is attached to. Set when activity_id resolves to an Appointment. Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties. - `task` string, uri — Task the file is attached to. Set when activity_id resolves to a Task. Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties. - `approval_process` string, uri — Approval process the file is attached to. Relation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties. - `call` string, uri — Call the file is attached to (e.g. a call recording). Relation to Call. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Call' object for properties. - `cloud_object_folder` string, uri — Folder the file is filed under within the parent record, or empty when stored at the record root. 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. - `cloud_object` string, uri — Cloud object (file) being linked. Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties. - `contact` string, uri — Contact the file is attached to, or empty when not attached to a contact. Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. - `custom_entity` string, uri — Custom entity record the file is attached to. Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties. - `email_sequence` string, uri — Email sequence the file is attached to. Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties. - `email_template` string, uri — Email template the file is attached to as a template attachment. Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. - `field_mapping` string, uri — Field mapping the file is attached to (e.g. an import file). Relation to FieldMapping. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FieldMapping' object for properties. - `lead` string, uri — Lead the file is attached to. Set when lead_oppty_id resolves to a Lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. - `oppty` string, uri — Opportunity the file is attached to. Set when lead_oppty_id resolves to an Opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. - `media` string, uri — Media record the file is attached to. Relation to Media. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Media' object for properties. - `email` string, uri — Email the file is attached to (e.g. an email attachment). Set when message_id resolves to an Email. Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties. - `memo` string, uri — Memo the file is attached to. Set when message_id resolves to a Memo. Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties. - `online_form_field` string, uri — Online form field the file was uploaded into. Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. - `online_form` string, uri — Online form submission the file was uploaded with. Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties. - `process` string, uri — Sales process the file is attached to. Relation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties. - `process_template` string, uri — Sales process template the file is attached to. Relation to ProcessTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessTemplate' object for properties. - `project` string, uri — Project the file is attached to. Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. - `quote` string, uri — Quote the file is attached to. Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties. - `report_schedule` string, uri — Report schedule the file is attached to (e.g. an exported report). Relation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties. - `text_message` string, uri — Text message (SMS/MMS) the file is attached to. Relation to TextMessage. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessage' object for properties. - `account_id` string, uuid — Id of the linked account. - `activity_id` string, uuid — Id of the linked appointment or task, or empty when not linked. - `approval_process_id` string, uuid — Id of the linked approval process. - `call_id` string, uuid — Id of the linked call. - `cloud_object_folder_id` string, uuid — Id of the folder within the parent record, or empty when stored at the record root. - `cloud_object_id` string, uuid — Id of the linked file. - `contact_id` string, uuid — Id of the linked contact. - `custom_entity_id` string, uuid — Id of the linked custom entity record. - `email_sequence_id` string, uuid — Id of the linked email sequence. - `email_template_id` string, uuid — Id of the linked email template. - `field_mapping_id` string, uuid — Id of the linked field mapping. - `lead_oppty_id` string, uuid — Id of the linked lead or opportunity, or empty when not linked. - `media_id` string, uuid — Id of the linked media record. - `message_id` string, uuid — Id of the linked email or memo, or empty when not linked. - `online_form_field_id` string, uuid — Id of the online form field the file was uploaded into. - `online_form_id` string, uuid — Id of the linked online form submission. - `process_id` string, uuid — Id of the linked sales process. - `process_template_id` string, uuid — Id of the linked sales process template. - `project_id` string, uuid — Id of the linked project. - `quote_id` string, uuid — Id of the linked quote. - `report_schedule_id` string, uuid — Id of the linked report schedule. - `text_message_id` string, uuid — Id of the linked text message. - `revision` integer — Revision when entity was lastly changed. ## 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)