Sign in

v2

latestOpenAPI 3.0.32026-08-05174296703.4 KB
ops

notifyUsersByEmailOps user

sends a notification by email to a list of users

post/ops/users/notify

Request body

email_liststring[] required

The list of emails to send the email to

language'de' | 'en' | 'nl' required
template_namestring required

the corresponding template name on SendGrid

Example request

{
  "email_list": [
    "abc123"
  ],
  "language": "en",
  "template_name": "abc123"
}

Response

OK response.

failed_countinteger required

Number of failed email deliveries.

failed_emailsstring[] required

List of email addresses that failed to send.

succeeded_countinteger required

Number of successfully sent emails.

total_countinteger required

Total number of emails attempted to send.

Example response

{
  "failed_count": 1,
  "failed_emails": [
    "abc123"
  ],
  "succeeded_count": 1,
  "total_count": 1
}