TOtopi
ops
ops-users

Email a notification to users

Changed on

sends a notification by email to a list of users

post/ops/users/notify

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/users/notify
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-user:read

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
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id user.notifyUsersByEmailOps removed and replaced with user#notifyUsersByEmailOps

  • 7ff7ee94b30eRevision changes
    • info

      api operation id user#notifyUsersByEmailOps removed and replaced with user.notifyUsersByEmailOps

    • info

      api tag ops-users added