Endpoints
Campaigns
Broadcast campaigns created in the app: status, results and sending.
Las rutas son relativas a la URL base. Cada tarjeta indica el permiso que necesita la llamada y cada parámetro, con su tipo y sus límites.
GET
/campaignsList campaigns, newest first.
Permiso: campaigns
Paginado
Parámetros de consulta
- statusopcionalenum
Campaign status.
Valores permitidos:
draftscheduledsendingcompletedfailed
GET
/campaigns/:idRetrieve a campaign with its delivery stats.
Permiso: campaigns
Parámetros de ruta
- idobligatoriostring
Campaign ID.
POST
/campaigns/:id/sendSend a draft, scheduled or failed campaign now, or schedule it.
Permiso: campaigns
Parámetros de ruta
- idobligatoriostring
Campaign ID.
Cuerpo JSON
- send_atopcionalstring (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.