These are the docs for the Metabase master branch. Some features documented here may not yet be available in the latest release. Check out the docs for the latest version, Metabase v0.50.

Email

/api/email endpoints.

DELETE /api/email/

Clear all email related settings. You must be a superuser or have setting permission to do this.

POST /api/email/test

Send a test email using the SMTP Settings. You must be a superuser or have setting permission to do this. Returns {:ok true} if we were able to send the message successfully, otherwise a standard 400 error response.

PUT /api/email/

Update multiple email Settings. You must be a superuser or have setting permission to do this.

PARAMS:

  • settings map

« Back to API index

Read docs for other versions of Metabase.

Thanks for your feedback!

Want to improve these docs? Propose a change.