Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Document

CloudObjectTemplates.update

Modifies CloudObjectTemplate or CloudObjectTemplates with given id(s)

patch/entities/CloudObjectTemplates/{id}

Path parameters

idstring uuid required

ID of CloudObjectTemplate to update

Query parameters

validation-levelinteger

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.

Request body

application_idstring uuid

Id of the producing application.

company_cloud_object_folder_idstring uuid

Id of the company folder, or empty when the object is not stored in the company tree.

creator_idstring uuid

Id of the uploading user.

filenamestring

File name (with extension) used when downloading the object.

is_publicboolean

When true, the object can be served via a public URL (see public_url).

status1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Active, 2 - Inactive

template_entity_name'Account' | 'AccountDataExRelation' | 'AccountKPI' | 'AccountProductPricing' | 'AccountRole' | 'AccountSharingClientRelation' | 'AccountSharingSalesUnitRelation' | 'AccountSocialRelation' | 'AccountType' | 'Activity' | 'ActivityComment' | 'ActivityDataExRelation' | 'ActivityDetail' | 'ActivityKPI' | 'ActivityRelation' | 'ActivityType' | 'AiAgent' | 'AiBalance' | 'AiEvent' | 'AiEventJournal' | 'AllowedAccountType' | 'AllowedCompanyPhone' | 'AllowedContactType' | 'AllowedLeadType' | 'AllowedPipeline' | 'AllowedQuoteType' | 'ApiAccess' | 'Application' | 'Appointment' | 'AppointmentClientInviteesRelation' | 'AppointmentContactInviteesRelation' | 'AppointmentInviteeNotifyQueue' | 'AppointmentReminder' | 'AppointmentSchedule' | 'AppointmentType' | 'Approval' | 'ApprovalApprover' | 'ApprovalProcess' | 'ApprovalProcessActivityLogLine' | 'AuditLog' | 'AutomationHubApp' | 'AutomationHubCategory' | 'AutomationHubItem' | 'ChatConversation' | 'Client' | 'ClientExcludedOppty' | 'ClientFavorite' | 'ClientSetting' | 'ClientStoryRead' | 'CloudObject' | 'CloudObjectFolder' | 'CloudObjectRelation' | 'CloudObjectStepRelation' | 'CloudObjectTemplate' | 'CompanyEmail' | 'Contact' | 'ContactAccountAccountRoleRelation' | 'ContactAccountRelation' | 'ContactDataExRelation' | 'ContactKPI' | 'ContactRelation' | 'ContactRelationType' | 'ContactSharingClientRelation' | 'ContactSharingSalesUnitRelation' | 'ContactSocialRelation' | 'ContactType' | 'Country' | 'CountryCrm' | 'CpActivity' | 'CpCallLog' | 'CpCalling' | 'CpClient' | 'CpProduct' | 'CpProfile' | 'CpTeamSpaceClient' | 'Currency' | 'CurrencyExchangeRate' | 'CurrencyExchangeRatesList' | 'CustomEntity' | 'CustomEntityDataExRelation' | 'CustomEntityKPI' | 'CustomEntityRelation' | 'CustomEntityRelationData' | 'CustomEntitySharingClientRelation' | 'CustomEntitySharingSalesUnitRelation' | 'CustomEntityType' | 'Data' | 'Ebook' | 'Email' | 'EmailContentSharingClientRelation' | 'EmailContentSharingSalesUnitRelation' | 'EmailMailboxRelation' | 'EmailSequence' | 'EmailSequenceActivityLog' | 'EmailSequenceActivityLogLine' | 'EmailSequenceEnrolled' | 'EmailSequenceEnrolledStatus' | 'EmailSequenceSettings' | 'EmailTemplate' | 'EmailTemplateFolder' | 'EmailTemplateSharingClientRelation' | 'EmailTemplateSharingSalesUnitRelation' | 'EmailThreadMailboxClientReadState' | 'Entity' | 'EntityFitness' | 'EntityFitnessIndicator' | 'EntityHealth' | 'EntityHealthSettingsHistory' | 'EntityScoring' | 'EntitySettings' | 'EntityType' | 'Field' | 'FieldMapping' | 'FieldPermission' | 'FieldSequence' | 'Forecast' | 'ForecastSharingClientRelation' | 'ForecastSharingSalesUnitRelation' | 'FormView' | 'FormViewSharingClientRelation' | 'FormViewSharingSalesUnitRelation' | 'GhostContact' | 'GhostContactAccountAccountRoleRelation' | 'GhostContactAccountRelation' | 'GhostLeadOpptyContactRelation' | 'GhostLeadOpptyContactSalesRoleRelation' | 'HowTo' | 'ImportMappingMask' | 'InterfacePreview' | 'Lead' | 'LeadOppty' | 'LeadOpptyAccountRelation' | 'LeadOpptyContactGroupRelation' | 'LeadOpptyContactRelation' | 'LeadOpptyContactSalesRoleRelation' | 'LeadOpptyDataExRelation' | 'LeadOpptyKPI' | 'LeadOpptyProjectRelation' | 'LeadOpptySharingClientRelation' | 'LeadOpptySharingSalesUnitRelation' | 'LeadOpptyStepCheckListRelation' | 'LeadOpptyType' | 'LeadProcess' | 'LeadType' | 'MasterRight' | 'Media' | 'Memo' | 'MemoComment' | 'Message' | 'MessageRelation' | 'MessageSharingClientRelation' | 'MessageSharingSalesUnitRelation' | 'Note' | 'NotificationSetting' | 'OnlineForm' | 'OnlineFormActivityLogLine' | 'OnlineFormDataExRelation' | 'OnlineFormRelation' | 'OnlineFormStyle' | 'OnlineFormType' | 'OnlineFormTypeEmailRelation' | 'Opportunity' | 'OpportunityType' | 'OpptyProductRelation' | 'OpptyProductRelationDataExRelation' | 'OpptyProductRelationRevenueSchedule' | 'OpptyProductRelationRevenueSchedulePeriod' | 'OpptyProductRelationType' | 'OpptyRecurrence' | 'OpptyRevenueSchedule' | 'OpptyRevenueSchedulePeriod' | 'Order' | 'OrderHistory' | 'OrderItem' | 'OrderRelatedDocument' | 'OrderTempData' | 'OrderTempDataItem' | 'ParentAccountRelationType' | 'Partner' | 'Payment' | 'PaymentAdditionalData' | 'PaymentTerm' | 'Phone' | 'Pipeline' | 'Process' | 'ProcessActivityLog' | 'ProcessActivityLogLine' | 'ProcessChangeOwnerLog' | 'ProcessScheduledAction' | 'ProcessTemplate' | 'Product' | 'ProductCategory' | 'ProductDataExRelation' | 'ProductPipelineRelation' | 'ProductPriceList' | 'ProductPriceListPrice' | 'ProductType' | 'Profile' | 'ProfileDraft' | 'ProfileRelation' | 'ProfileSharingClientRelation' | 'ProfileSharingSalesUnitRelation' | 'Project' | 'ProjectContactRelation' | 'ProjectDataExRelation' | 'ProjectKPI' | 'ProjectObjective' | 'ProjectSharingClientRelation' | 'ProjectSharingSalesUnitRelation' | 'ProjectType' | 'PurchasedProduct' | 'Quote' | 'QuoteAccountRelation' | 'QuoteContactRelation' | 'QuoteDataExRelation' | 'QuoteKPI' | 'QuoteProcess' | 'QuoteSharingClientRelation' | 'QuoteSharingSalesUnitRelation' | 'QuoteType' | 'ReleaseNote' | 'Report' | 'ReportFolder' | 'ReportSchedule' | 'ReportSharingClientRelation' | 'ReportSharingSalesUnitRelation' | 'RevenueRecognition' | 'SalesRole' | 'SalesUnit' | 'SalesUnitClientRelation' | 'SapiUser' | 'SpaceSetting' | 'State' | 'Step' | 'StepChecklist' | 'StepChecklistSalesRoleRelation' | 'Storylane' | 'Subscription' | 'SubscriptionHubItem' | 'SubscriptionNotification' | 'SubscriptionRepresentative' | 'SubscriptionSDR' | 'Supplier' | 'Tag' | 'TagRelation' | 'Target' | 'TargetRelation' | 'Task' | 'TaskRecurrence' | 'TaskReminder' | 'TaskSharingClientRelation' | 'TaskSharingSalesUnitRelation' | 'TaskType' | 'TeamPipelineHubItem' | 'TeamPipelineHubItemBase' | 'TeamSpace' | 'TeamSpaceClient' | 'TeamSpaceClientSetting' | 'TeamSpaceProperty' | 'TeamSpaceRegion' | 'TextMessage' | 'TextMessageConversation' | 'TextMessageConversationRelations' | 'Timeframe' | 'Translation' | 'Type' | 'UnsubscribedPhone' | 'UseCase' | 'UserProfile' | 'UserRole' | 'Webhook' | 'WebhookEvent' | 'Webresource'

Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via template_entity_api_name.

upload_source1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor

revisioninteger

Revision when entity was lastly changed.

contentstring binary

Data content of the object.

template_entity_api_namestring

API name of the custom entity the template renders. Set only when template_entity_name is "CustomEntity"; otherwise empty.

Example request

{
  "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",
  "status": 1,
  "template_entity_name": "Account",
  "upload_source": 1,
  "revision": 1,
  "content": "blob",
  "template_entity_api_name": "string"
}

Response

Modification confirmation. Returns resulting CloudObjectTemplate

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",
    "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",
    "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"
  }
}