GraphQL API
Organization API
Organization / Communication templates

communicationTemplatePreview

Render a deterministic preview using the supplied content overrides.

Arguments

4 arguments
brandIdID!

ID of the brand.

localeString!

Locale used for the result.

overridesMixed

Sparse content overrides applied only to this preview.

Communication template type to preview.

fulfillment_shipped_emailorder_address_incorrect_emailpacking_slip_documentportal_return_step_methodportal_return_step_refundportal_return_step_statusreturn_refund_coupon_emailreturn_request_accepted_emailreturn_request_received_emailreturn_request_rejected_email

Possible return

base64String!

Base64 of the communication template preview artifact.

mimeTypeString!

MIME type of the communication template preview artifact.

contentMixed

Content of the communication template preview.

codeString!

Code of the communication template diagnostic.

fieldString

Field of the communication template diagnostic.

messageString!

Message of the communication template diagnostic.

severityString!

Severity of the communication template diagnostic.