Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Document

CloudObjectRelations.update

Modifies CloudObjectRelation or CloudObjectRelations with given id(s)

patch/entities/CloudObjectRelations/{id}

Path parameters

idstring uuid required

ID of CloudObjectRelation to update

Query parameters

validation-levelinteger

Specify validation level of CloudObjectRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

account_idstring uuid

Id of the linked account.

activity_idstring uuid

Id of the linked appointment or task, or empty when not linked.

approval_process_idstring uuid

Id of the linked approval process.

call_idstring uuid

Id of the linked call.

cloud_object_folder_idstring uuid

Id of the folder within the parent record, or empty when stored at the record root.

cloud_object_idstring uuid

Id of the linked file.

contact_idstring uuid

Id of the linked contact.

custom_entity_idstring uuid

Id of the linked custom entity record.

email_sequence_idstring uuid

Id of the linked email sequence.

email_template_idstring uuid

Id of the linked email template.

field_mapping_idstring uuid

Id of the linked field mapping.

lead_oppty_idstring uuid

Id of the linked lead or opportunity, or empty when not linked.

media_idstring uuid

Id of the linked media record.

message_idstring uuid

Id of the linked email or memo, or empty when not linked.

online_form_field_idstring uuid

Id of the online form field the file was uploaded into.

online_form_idstring uuid

Id of the linked online form submission.

process_idstring uuid

Id of the linked sales process.

process_template_idstring uuid

Id of the linked sales process template.

project_idstring uuid

Id of the linked project.

quote_idstring uuid

Id of the linked quote.

report_schedule_idstring uuid

Id of the linked report schedule.

text_message_idstring uuid

Id of the linked text message.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "activity_id": "01234567-abcd-dcba-ffff-000000000000",
  "approval_process_id": "01234567-abcd-dcba-ffff-000000000000",
  "call_id": "01234567-abcd-dcba-ffff-000000000000",
  "cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
  "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
  "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
  "email_template_id": "01234567-abcd-dcba-ffff-000000000000",
  "field_mapping_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "media_id": "01234567-abcd-dcba-ffff-000000000000",
  "message_id": "01234567-abcd-dcba-ffff-000000000000",
  "online_form_field_id": "01234567-abcd-dcba-ffff-000000000000",
  "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
  "process_id": "01234567-abcd-dcba-ffff-000000000000",
  "process_template_id": "01234567-abcd-dcba-ffff-000000000000",
  "project_id": "01234567-abcd-dcba-ffff-000000000000",
  "quote_id": "01234567-abcd-dcba-ffff-000000000000",
  "report_schedule_id": "01234567-abcd-dcba-ffff-000000000000",
  "text_message_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting CloudObjectRelation

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "activity_id": "01234567-abcd-dcba-ffff-000000000000",
    "approval_process_id": "01234567-abcd-dcba-ffff-000000000000",
    "call_id": "01234567-abcd-dcba-ffff-000000000000",
    "cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
    "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_template_id": "01234567-abcd-dcba-ffff-000000000000",
    "field_mapping_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "media_id": "01234567-abcd-dcba-ffff-000000000000",
    "message_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
    "process_id": "01234567-abcd-dcba-ffff-000000000000",
    "process_template_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "report_schedule_id": "01234567-abcd-dcba-ffff-000000000000",
    "text_message_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}