Hoppa till innehållet
Qrona Newsletter
Logga inSkapa konto

Referens / Qrona-mallar

Rendera mall

POST/api/v1/templates/{key}/render

Mallens senast publicerade version med datan, precis som den skickas – för förhandsvisningen i Qrona.

Datan kontrolleras mot mallens datakontrakt som när ett meddelande skickas. Ingenting skickas och ingenting sparas.

Mallar och datakontrakt →

Behörighet

  • templates:render Förhandsgranska meddelanden – personen bakom nyckeln måste vara alla medlemmar.

Sökvägsparametrar

keystringkrävs
Mallens nyckel, samma som datakontraktets.

Kropp

JSON, Content-Type: application/json. Okända fält ger 422.

dataobject<valfritt>krävs
Meddelandets data, färdig att visa (belopp formaterade, datum utskrivna). Kontrolleras mot mallens datakontrakt.
categorystring
Klassen meddelandet ska ha (som när det skickas). Utan: service.servicemarketing
toobject
En mottagare att visa det för. Utan: ett exempelnamn.
to.emailstringkrävs
Mottagarens adress.högst 254 tecken
to.namestring | null
Mottagarens namn. Fyller {{first_name}} och {{last_name}} i mallen.högst 200 tecken

Göra om anropet

Skicka gärna headern Idempotency-Key (t.ex. ett uuid). Skickas samma anrop igen med samma nyckel inom 24 timmar kommer det första svaret tillbaka, utan att något görs två gånger. Batch och idempotens

Svar

200 Den renderade mallen.

templatestringkrävs
template_versionintegerkrävs
Versionen som renderades: den senast publicerade, som ett meddelande skulle göras av nu.
subjectstringkrävs
Ämnesraden, ifylld.
htmlstringkrävs
Meddelandet som HTML, precis som det skickas (länkarna till webbversion och avregistrering leder ingenstans i en förhandsvisning).
textstringkrävs
Textversionen.
warningsarray<string>krävs
Det som borde ses över, t.ex. en länk utan adress.

Fel

400
bad_request
401
unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive
402
payment_required
403
insufficient_scopeforbiddenworkspace_suspended
404
not_found
409
template_not_publishedidempotency_in_progress
415
unsupported_media_type
422
validation_failedidempotency_key_reused
429
rate_limited
500
internal_error