Endpoints
Campaigns
Broadcast campaigns created in the app: status, results and sending.
Les chemins sont relatifs à l’URL de base. Chaque carte indique la permission requise par l’appel et chaque paramètre, avec son type et ses limites.
GET
/campaignsList campaigns, newest first.
Permission : campaigns
Paginé
Paramètres de requête
- statusfacultatifenum
Campaign status.
Valeurs autorisées :
draftscheduledsendingcompletedfailed
GET
/campaigns/:idRetrieve a campaign with its delivery stats.
Permission : campaigns
Paramètres de chemin
- idobligatoirestring
Campaign ID.
POST
/campaigns/:id/sendSend a draft, scheduled or failed campaign now, or schedule it.
Permission : campaigns
Paramètres de chemin
- idobligatoirestring
Campaign ID.
Corps JSON
- send_atfacultatifstring (ISO 8601 date-time with offset) | null
Schedule for this time. Omit or null to send now.
- Sending now answers 202 and runs in the background; campaign.completed fires when it finishes. Scheduling answers 200.
- 402 insufficient_credits when the workspace cannot pay for the send; 409 for a campaign that is already sending or completed.