Spore
DocumentationTarifs

API v0.1.0

Référence API

Control plane for the Spore transactional email platform.

Toutes les URLs partent de https://api.sporee.fr. Les opérations marquées comme authentifiées attendent Authorization: Bearer sk_live_….

Account

DELETEDelete your own account/accountGETThe account the caller acts on/me

Api Keys

GETList API keys/api-keysPOSTCreate an API key/api-keysDELETERevoke an API key/api-keys/{id}

Billing

GETRead the public plan catalogue/billing/cataloguePOSTOpen a checkout for a paid plan/billing/checkoutGETRead how a checkout ended/billing/checkout/{session_id}GETList how a plan may be paid for/billing/checkout/methodsPOSTSchedule a downgrade to a smaller plan/billing/downgradeDELETEWithdraw a scheduled plan change/billing/pending-changeGETGet the calling tenant's billing state/billing/stateDELETECancel the subscription/billing/subscriptionPOSTUpgrade to a larger plan/billing/upgradePOSTQuote what an upgrade would cost/billing/upgrade/quotePOSTLungor subscription webhook/billing/webhook/lungor

Branding

GETGet the branding for a sending identity/identities/{id}/brandPUTSet the branding for a sending identity/identities/{id}/brandPOSTExtract a branding suggestion from a URL or HTML/identities/{id}/brand/extract

Identities

GETList sending identities/identitiesPOSTRegister a sending identity/identitiesGETGet a sending identity/identities/{id}DELETEDelete a sending identity/identities/{id}POSTAdd an allowed From address (local-part) on a verified identity/identities/{id}/addressesDELETERemove an allowed From address/identities/{id}/addresses/{localPart}POSTDisable an allowed From address/identities/{id}/addresses/{localPart}/disablePOSTVerify a sending identity's DNS records/identities/{id}/verify

Inbound

GETList inbound messages/inbound/messagesGETGet one inbound message/inbound/messages/{id}

Internal

POSTIngest a raw RFC 3464 bounce DSN/internal/bouncesPOSTIngest a raw RFC 5322 inbound message/internal/inboundPOSTDeclare a tenant to the billing service (service-to-service)/internal/tenant/billing-customerGETRead an invitation without consuming it (service-to-service)/internal/tenant/invitation/{token}POSTRedeem an invitation onto a tenant (service-to-service)/internal/tenant/invitation/claimPOSTAssign a plan to a tenant (service-to-service)/internal/tenant/plan

Messaging

GETList enqueued/sent messages/emailsPOSTEnqueue a transactional email/emailsGETGet a message/emails/{id}POSTSend a diagnostic test email from the UI/emails/test

Plans

POSTRedeem the invitation your sign-up carried/tenant/invitation/claimPOSTReplay the invitation your sign-up carried/tenant/invitation/repairGETGet the calling tenant's plan/tenant/plan

Reputation

POSTLift a sending freeze on a tenant/internal/reputation/{tenantId}/unfreezeGETGet the current sending reputation for the authenticated tenant/reputation

Suppressions

GETList suppressed emails/suppressionsPOSTAdd an email to the suppression list/suppressionsDELETERemove an email from the suppression list/suppressions/{email}

Templates

GETList built-in email templates/templatesPOSTRender a preview of a template/templates/{id}/preview

Unsubscribe

GETRender the unsubscribe confirmation page/unsubscribePOSTOne-click unsubscribe (RFC 8058)/unsubscribe

Unsubscribes

GETList unsubscribe events/unsubscribes

Usage

GETGet the calling tenant's current and historical usage/usage

Webhooks

GETList webhook endpoints/webhooks/endpointsPOSTCreate a webhook endpoint/webhooks/endpointsGETGet a webhook endpoint/webhooks/endpoints/{id}PATCHUpdate a webhook endpoint/webhooks/endpoints/{id}DELETEDelete a webhook endpoint/webhooks/endpoints/{id}POSTRotate a webhook endpoint's signing secret/webhooks/endpoints/{id}/rotate-secret