Send alert email

Overview

Send the error-notification alert email, either to the store's configured response-posting error recipients (email_to=admin) or to a custom address (email_to=other).

Prerequisites

• A bearer token. Callable with Partner tokens.

Base URL

Endpoint

POST /api/v1/partner/error-notifications/send-email-notification

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.
• Who can call it: Partner tokens.
• Authentication is under the partner prefix.
• The request validation checks that notification_id exists. There is no partner-tree / company scoping on which notification is emailed.
• The controller 400s in three cases. These are: the notification is missing or has empty content (No notification is available), the linked store is missing (Location does not exist.), or no recipient resolves (User does not exist.).
• For admin, recipients come from the store's configured response-posting error recipients; for other, the email field is used. The mail is then sent.

Rate limit

• No rate limit.

Request body

• Body:

{
  "notification_id": 1215,
  "email_to": "other",
  "email": "[email protected]"
}

Response

• data.status (string) — success.
• data.message (string) — Email sent successfully!

200 Success · 200

{
  "data": { "status": "success", "message": "Email sent successfully!" }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/error-notifications/send-email-notification" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"notification_id": 1215, "email_to": "other", "email": "[email protected]"}'