COcoevera
Document

CloudObjectTemplates.batch_create_or_update

Creates or updates CloudObjectTemplate records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/CloudObjectTemplates/batch-modify

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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

Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active.

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' | 'AllowedAppointmentType' | 'AllowedCompanyPhone' | 'AllowedContactType' | 'AllowedLeadType' | 'AllowedPipeline' | 'AllowedQuoteType' | 'AllowedTaskType' | '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' | 'EmailLabel' | 'EmailLabelRelation' | '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' | 'Solution' | 'SolutionTemplate' | '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

Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images.

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.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.