Skip to main content

Endpoint

POST /api/v1/campaigns

Body

ChampTypeRequisDescription
instanceIdUUIDouiInstance source
namestringouiNom interne
scheduleISO 8601ouiDate de démarrage
templateIdUUIDnonTemplate utilisé
variablesobjectnonVariables custom.* globales
repeatstringnonnone, daily, weekly
recipientsobjectouiSélecteur de destinataires

recipients

ChampTypeRequisDescription
typeenumouiall, tags, explicit
valuestring[]selon typeTags ou IDs de contacts

Réponse succès 201

{
  "data": {
    "id": "cmp_uuid",
    "status": "scheduled",
    "stats": {
      "planned": 0,
      "queued": 0,
      "sent": 0,
      "delivered": 0,
      "read": 0,
      "failed": 0,
      "cancelled": 0
    }
  }
}

Erreurs courantes

HTTPCodeQuand
400VALIDATION_ERRORBody invalide
403CAMPAIGNS_NOT_AVAILABLE_ON_PLANPlan trop faible
404NOT_FOUNDInstance ou template introuvable