COcoevera
Email

EmailTemplates.batch_create_or_update

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

post/entities/EmailTemplates/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

bodystring

HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed.

email_template_folder_idstring uuid

Id of the folder the template belongs to. Empty for templates at the root level.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the template owner.

recent_colorsobject

Colors recently used in the editor of the template body, as integer color values.

share_mode0 | 1 | 2 | 3

Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all).

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

sharing_url_is_enabledboolean

When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs.

sharing_url_settingsobject

Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured.

subjectstring

Subject line of emails composed from this template. Supports merge-field placeholders.

type0 | 1 | 2

Template format: plain text (TextTemplate), raw HTML (HtmlTemplate) or built in the visual editor (WysiwygTemplate).

Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate

revisioninteger

Revision when entity was lastly changed.

idstring uuid

ID of object to update.

Example request

[
  {
    "body": "string",
    "email_template_folder_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "subject": "string",
    "revision": 1
  }
]

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.