CloudObjectTemplates.update

Modifies CloudObjectTemplate or CloudObjectTemplates with given id(s)

Request

Path Params

string <uuid>

required

ID of CloudObjectTemplate to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of CloudObjectTemplate 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.

Body Params application/json

application_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

company_cloud_object_folder_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

creator_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

filename

string

optional

Simple text input field.

Example:

string

is_public

boolean

optional

Boolean value.

Example:

false

status

enum<integer>

optional

Integer enum value: 1 - Active, 2 - Inactive

Allowed values:

Example:

template_entity_name

enum<string>

optional

Allowed values:

AccountAccountDataExRelationAccountKPIAccountRoleAccountSharingClientRelationAccountSharingSalesUnitRelationAccountSocialRelationAccountTypeActivityActivityCommentActivityDataExRelationActivityDetailActivityKPIActivityRelationActivityTypeAllowedAccountTypeAllowedCompanyPhoneAllowedContactTypeAllowedLeadTypeAllowedPipelineAllowedQuoteTypeApiAccessApplicationAppointmentAppointmentClientInviteesRelationAppointmentContactInviteesRelationAppointmentInviteeNotifyQueueAppointmentReminderAppointmentScheduleAppointmentTypeApprovalApprovalApproverApprovalProcessApprovalProcessActivityLogLineAuditLogAutomationHubAppAutomationHubCategoryAutomationHubItemClientClientExcludedOpptyClientFavoriteClientSettingClientStoryReadCloudObjectCloudObjectFolderCloudObjectRelationCloudObjectStepRelationCloudObjectTemplateCompanyEmailContactContactAccountAccountRoleRelationContactAccountRelationContactDataExRelationContactKPIContactRelationContactRelationTypeContactSharingClientRelationContactSharingSalesUnitRelationContactSocialRelationContactTypeCountryCpActivityCpCallLogCpCallingCpClientCpProductCpProfileCpTeamSpaceClientCurrencyCurrencyExchangeRateCurrencyExchangeRatesListCustomEntityCustomEntityDataExRelationCustomEntityKPICustomEntityRelationCustomEntityRelationDataCustomEntitySharingClientRelationCustomEntitySharingSalesUnitRelationCustomEntityTypeDataDataRelationEmailEmailContentSharingClientRelationEmailContentSharingSalesUnitRelationEmailSequenceEmailSequenceActivityLogEmailSequenceActivityLogLineEmailSequenceEnrolledEmailSequenceEnrolledStatusEmailSequenceSettingsEmailTemplateEmailTemplateFolderEmailTemplateSharingClientRelationEmailTemplateSharingSalesUnitRelationEntityEntityFitnessEntityFitnessIndicatorEntityHealthEntityHealthSettingsHistoryEntityScoringEntitySettingsEntityTypeFieldFieldMappingFieldPermissionFieldSequenceForecastForecastSharingClientRelationForecastSharingSalesUnitRelationFormViewFormViewSharingClientRelationFormViewSharingSalesUnitRelationGhostContactGhostContactAccountAccountRoleRelationGhostContactAccountRelationGhostLeadOpptyContactRelationGhostLeadOpptyContactSalesRoleRelationHowToImportMappingMaskInterfacePreviewLeadLeadOpptyLeadOpptyAccountRelationLeadOpptyContactGroupRelationLeadOpptyContactRelationLeadOpptyContactSalesRoleRelationLeadOpptyDataExRelationLeadOpptyKPILeadOpptyProjectRelationLeadOpptySharingClientRelationLeadOpptySharingSalesUnitRelationLeadOpptyStepCheckListRelationLeadOpptyTypeLeadProcessLeadTypeMasterRightMediaMemoMemoCommentMessageMessageRelationMessageSharingClientRelationMessageSharingSalesUnitRelationNoteNotificationSettingOnlineFormOnlineFormActivityLogLineOnlineFormDataExRelationOnlineFormRelationOnlineFormStyleOnlineFormTypeOnlineFormTypeEmailRelationOpportunityOpportunityTypeOpptyProductRelationOpptyProductRelationDataExRelationOpptyProductRelationRevenueScheduleOpptyProductRelationRevenueSchedulePeriodOpptyProductRelationTypeOpptyRecurrenceOpptyRevenueScheduleOpptyRevenueSchedulePeriodOrderOrderHistoryOrderItemOrderRelatedDocumentOrderTempDataOrderTempDataItemParentAccountRelationTypePartnerPaymentPaymentAdditionalDataPaymentTermPhonePipelineProcessProcessActivityLogProcessActivityLogLineProcessChangeOwnerLogProcessScheduledActionProcessTemplateProductProductCategoryProductDataExRelationProductPipelineRelationProductPriceListProductPriceListPriceProductTypeProfileProfileDraftProfileRelationProfileSharingClientRelationProfileSharingSalesUnitRelationProjectProjectContactRelationProjectDataExRelationProjectKPIProjectObjectiveProjectSharingClientRelationProjectSharingSalesUnitRelationProjectTypePurchasedProductQuoteQuoteAccountRelationQuoteContactRelationQuoteDataExRelationQuoteKPIQuoteProcessQuoteSharingClientRelationQuoteSharingSalesUnitRelationQuoteTypeReleaseNoteReportReportFolderReportScheduleReportSharingClientRelationReportSharingSalesUnitRelationRevenueRecognitionSalesRoleSalesUnitSalesUnitClientRelationSapiUserSpaceSettingStateStepStepChecklistStepChecklistSalesRoleRelationStorylaneSubscriptionSubscriptionHubItemSubscriptionNotificationSubscriptionRepresentativeSubscriptionSDRSupplierTagTagRelationTargetTargetRelationTaskTaskRecurrenceTaskReminderTaskSharingClientRelationTaskSharingSalesUnitRelationTaskTypeTeamPipelineHubItemTeamPipelineHubItemBaseTeamSpaceTeamSpaceClientTeamSpaceClientSettingTeamSpacePropertyTeamSpaceRegionTextMessageTextMessageConversationTextMessageConversationRelationsTimeframeTranslationTypeUnsubscribedPhoneUserProfileUserRoleWebhookWebhookEventWebresource

Example:

Account

upload_source

enum<integer>

optional

Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor

Allowed values:

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

content

string <binary>

optional

Data content of the object.

Example:

blob

template_entity_api_name

string

optional

Example:

string

Example

{
    "application_id": "01234567-abcd-dcba-ffff-000000000000",
    "company_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
    "creator_id": "01234567-abcd-dcba-ffff-000000000000",
    "filename": "string",
    "is_public": false,
    "status": 1,
    "template_entity_name": "Account",
    "upload_source": 1,
    "revision": 1,
    "content": "blob",
    "template_entity_api_name": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting CloudObjectTemplate

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (CloudObjectTemplate)

optional

is_delete_protected

boolean

read-onlyrequired

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.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

application

string <uri>

optional

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>

optional

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>

optional

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>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

company_cloud_object_folder_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

creator_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

filename

string

required

Simple text input field.

Example:

string

is_public

boolean

optional

Boolean value.

Example:

false

mime_type

string

read-onlyoptional

Mime-type of the cloud object Is detected from content.

Example:

string

size

integer <int32>

read-onlyrequired

Size of the object in bytes.

Example:

status

enum<integer>

optional

Integer enum value: 1 - Active, 2 - Inactive

Allowed values:

Example:

template_entity_name

enum<string>

required

Allowed values:

Example:

Account

type

enum<integer>

read-onlyrequired

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

Allowed values:

-112345678910

Example:

-1

upload_source

enum<integer>

optional

Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor

Allowed values:

Example:

url

string

read-onlyoptional

URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

template_entity_api_name

string

optional

Example:

string

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "application": "http://example.com",
        "company_cloud_object_folder": "http://example.com",
        "creator": "http://example.com",
        "application_id": "01234567-abcd-dcba-ffff-000000000000",
        "company_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
        "creator_id": "01234567-abcd-dcba-ffff-000000000000",
        "filename": "string",
        "is_public": false,
        "mime_type": "string",
        "size": 1,
        "status": 1,
        "template_entity_name": "Account",
        "type": -1,
        "upload_source": 1,
        "url": "string",
        "revision": 1,
        "template_entity_api_name": "string"
    }
}

🟠404Record Not Found

🔴500Server Error