Hoppa till innehållet

Referens / Meddelanden

Skicka meddelande

POST/api/v1/messages

Ett meddelande till en mottagare, gjort av mallens senast publicerade version och datan. Skickas direkt.

Datan kontrolleras mot mallens datakontrakt innan något skickas. Meddelandet sparar mallversionen och HTML:ens SHA-256, så att det som skickades alltid kan visas igen.

idempotency_key är unik per arbetsyta: samma nyckel igen svarar 200 med det första meddelandet och skickar inget nytt, så ett omförsök blir aldrig en dubblett. Samma nyckel med annat innehåll ger 409 idempotency_conflict.

Ett meddelande som inte får gå – adressen är spärrad för klassen, eller månadens pott är slut – sparas med status suppressed och reason, och kvittot message.suppressed skickas. Svaret är då ändå 201.

Guide: meddelanden från Qrona →

Behörighet

  • messages:send Skicka meddelanden – personen bakom nyckeln måste vara alla medlemmar.

Kropp

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

templatestringkrävs
Mallens nyckel. Meddelandet görs från mallens senast publicerade version.
toobjectkrävs
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
categorystringkrävs
service: påminnelser och brev inom uppdraget – stoppas av studs, skräppostanmälan, radering och manuell spärr, aldrig av en avregistrering, och har ingen avregistreringslänk. marketing: planerings- och kunskapsbrev – följer arbetsytans vanliga regler, avregistreringar och månadstaket.servicemarketing
dataobject<valfritt>krävs
Meddelandets data, färdig att visa (belopp formaterade, datum utskrivna). Kontrolleras mot mallens datakontrakt.
idempotency_keystringkrävs
Unik per arbetsyta och meddelande, t.ex. utskickets id i Qrona. Samma nyckel igen ger samma meddelande, aldrig ett nytt.minst 1 tecken · högst 255 tecken
referencestringkrävs
Qronas referens. Kommer tillbaka i varje kvitto (webhook).minst 1 tecken · högst 255 tecken
client_refstringkrävs
Byråns klient, pseudonymt. Antalet olika klienter per månad är underlaget för fakturan.minst 1 tecken · högst 255 tecken
reply_tostring | null
Svarsadress för just det här meddelandet, t.ex. klientens konsult. Utan: tilläggets.högst 320 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

201 Meddelandet (200 när idempotency_key redan använts med samma innehåll).

message_idstringkrävs
Meddelandets id.
statusstringkrävs
queued: väntar på ett nytt försök · sent: lämnat till utskickstjänsten · delivered: levererat · bounced: studsade · complained: skräppostanmälan · failed: kunde inte levereras · suppressed: skickades inte, se reason.queuedsendingsentdeliveredbouncedcomplainedfailedsuppressed
reasonstring | nullkrävs
Varför ett meddelande inte skickades: bounced, complained, manual, erased, unsubscribed (bara marketing), service_limit, monthly_cap eller payment.
templatestringkrävs
template_versionintegerkrävs
Mallversionen meddelandet gjordes av. Publicerade versioner ändras aldrig.
html_sha256stringkrävs
SHA-256 av HTML:en mottagaren fick.
categorystringkrävs
servicemarketing
referencestringkrävs
client_refstringkrävs
created_atstring (tid, ISO 8601)krävs
När meddelandet togs emot.

Fel