API Reference
Log In
API Reference

Create/update an email delivery provider (unified)

post
https://api.caniphish.com/api/v3/settings/email-delivery/save-email-delivery

Single endpoint for all delivery providers. Set provider and supply the matching config object — smtpConfig, m365Config (white-label flow: your own Azure app registration) or googleConfig. Upserts by instanceName. The instanceName is sanitized (non-alphanumeric characters become hyphens), and the reserved name "Managed Instance" is stored as "Customer Managed Instance".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
enum
required

Which provider to save. Determines which config object is read; the others are ignored.

Allowed:
string
required

Display name of the delivery instance; upserts by this name. For m365 it is sanitized to [a-zA-Z0-9-].

smtpConfig
object

Required when provider is "smtp".

m365Config
object

Required when provider is "m365". Azure app registration for white-label Direct Email Injection; applicationId/azureTenantId must match ^[a-zA-Z0-9-]+$.

googleConfig
object

Required when provider is "google".

Responses

Updated about 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago