1. Home
  2. Docs
  3. API
  4. Special Endpoints
  5. Sending emails

Sending emails

To send email to your users using the API, you need to use the endpoint ApiGoat/sendEmail

POST https://x.apigoat.com/p/YOUR-PROJECT-NAME/api/v1/ApiGoat/sendEmail HTTP/1.1
Content-type: application/json
Accept: application/json

{
  "Email":"fvezina@gmail.com",
  "TemplateName": "Forgotten password email"
}

The email must be an existing email.

The template must exists in your application. To create a template, use the built-in interface. Learn about Templates.

Important! When sending an email, the endpoint will automatically create an insert a new ValidationKey if there is none for the user. This is to make sure that the Template variable [Authy-ValidationKey] exists. It will not overwrite an existing one.

How can we help?

Leave a Reply