Hoppa till innehåll
WeZend

Kampanjer & innehåll

API-utlösta kampanjer: skicka en sparad kampanj

POST /v1/campaigns/:id/trigger skickar en sparad kampanj till personer du anger, med egna data, eller till listor och segment.

POST /v1/campaigns/{id}/trigger skickar en sparad kampanj från ditt eget system: en order läggs, ett formulär fylls i, en automation utlöses. I meddelandet är datan {{ trigger.order_id }} (Liquid). Det kräver en API-nyckel med behörigheten send eller en dashboard-användare som får starta.

{
  "recipients": [
    { "email": "ann@example.com", "data": { "order_id": "1001", "total": "99 EUR" } },
    { "contact_id": "…", "data": { "order_id": "1002" } }
  ],
  "data": { "shop": "Acme" },
  "idempotency_key": "order-1001"
}

Svaret är 202 { campaign_id, accepted, unmatched, opted_out }. Du kan skicka 1 till 1 000 mottagare per anrop; data är högst 50 nycklar och 8 000 tecken per mottagare. Delad data gäller alla, och en mottagares egen data vinner.

Rikta dig till en målgrupp i stället

I stället för recipients anger du list_ids och/eller segment_ids (upp till 20 id:n; kontots egna, annars list_not_found eller segment_not_found). Målgruppen läses när det skickas, och svaret är 202 { campaign_id, audience }.

Regler

  • Den sparade kampanjen är mallen. Varje utlösning kopierar den till en egen kampanj med namnet "<namn> (API trigger)"; den sparade rörs aldrig. Bara en draft-, sent- eller active-kampanj kan utlösas (409 campaign_not_triggerable).
  • Mottagare måste redan vara kontakter. Okända personer kommer tillbaka i unmatched och skapas aldrig. Personer som valt bort utelämnas och räknas i opted_out.
  • Allt en kampanjutskick upprätthåller körs fortfarande: double opt-in, suppression, frekvenstak och tysta timmar, kvot, saldo, holdout, A/B, rabattkodspooler. Värden HTML-escapas i e-post.
  • idempotency_key: samma nyckel på samma sparade kampanj svarar 200 { duplicate: true, campaign_id } och skickar inget igen, även vid parallella anrop. Sätt en om din anropare försöker igen.
  • Ett nytt kontos första e-postkampanj väntar på att en människa granskar den, så en utlösning svarar 409 first_campaign_needs_review innan något kopieras. Skicka kampanjen en gång från dashboarden först.
  • En felaktig body, ett annat kontos kampanj (404), en skrivskyddad nyckel (403) och ingen nyckel (401) nekas innan något skickas.

Vill du skapa kontakten först, anropa POST /v1/contacts/upsert.

En plattform. Varje kundinteraktion.

Ersätt ditt lapptäcke av meddelande-API:er, CDP och automationsverktyg med en engagemangsplattform byggd för skala.

Inget kreditkort · EU-datalagring · 99,99 % drifttids-SLA