Endpoints
Campaigns
Broadcast campaigns created in the app: status, results and sending.
Οι διαδρομές είναι σχετικές με το βασικό URL. Κάθε κάρτα δείχνει το δικαίωμα που απαιτεί η κλήση και κάθε παράμετρο, με τον τύπο και τα όριά της.
GET
/campaignsList campaigns, newest first.
Δικαίωμα: campaigns
Με σελιδοποίηση
Παράμετροι query
- statusπροαιρετικόenum
Campaign status.
Επιτρεπτές τιμές:
draftscheduledsendingcompletedfailed
GET
/campaigns/:idRetrieve a campaign with its delivery stats.
Δικαίωμα: campaigns
Παράμετροι διαδρομής
- idυποχρεωτικόstring
Campaign ID.
POST
/campaigns/:id/sendSend a draft, scheduled or failed campaign now, or schedule it.
Δικαίωμα: campaigns
Παράμετροι διαδρομής
- idυποχρεωτικόstring
Campaign ID.
Σώμα JSON
- send_atπροαιρετικόstring (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.