ReDoc documentation

custom-email/templates

custom-email/templates

Retrieve custom email templates matching the given search criteria.

Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/V1/custom-email/templates
Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

custom-email/templates

Create a custom email template. Server-assigned fields (template_id, added_at, modified_at) and the strict-mode flag (is_legacy = 0) are set by the service; any value supplied for them is ignored. The template_code must be unique. Returns the persisted template, including its server-assigned template_id (usable as-is with POST /V1/custom-email/send).

Request
Request Body schema:
required
object (custom-email-template-data-email-template-detail-interface)

Full custom email template DTO returned by the single-resource (detail) read. Extends the lean list DTO with the heavy content fields (template_text, template_styles) that the list endpoint deliberately omits. The WebAPI serializer renders fields from the declared return type, so exposing these here — and only here — keeps GET /V1/custom-email/templates a summary while GET /V1/custom-email/templates/{id} returns the complete template.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/V1/custom-email/templates
Request samples
{
  • "template": {
    }
}
Response samples
{
  • "added_at": "string",
  • "modified_at": "string",
  • "template_code": "string",
  • "template_id": 0,
  • "template_styles": "string",
  • "template_subject": "string",
  • "template_text": "string",
  • "template_type": "string"
}
➔ Next to custom-email/templates/{templateId}