Create email pattern

Creates a new email notifier pattern

HTTP Request

POST/api/notifications/notifiers/email/:id/patterns

Authorization

Authorization

• Required: Yes
• Permission: Staff with EmailPatternsPermission or Admin
• Permission Code: 2841
• Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters

Parameter	Type	Required	Description
id	Integer	Yes	Unique ID of the email notifier

Request Body

Field	Type	Required	Description
name	String	Yes	Name of the email notifier pattern (unique over the specific email notifier)
description	String	No	Extra description about the email notifier pattern
from_email	String	No	from_email address
subject	String	Yes	The subject field of the email
body_text	String	Yes	The text body of the email pattern
body_html	String	No	The html body of the email pattern

Example Requests

🐍 Python

1import requests
2
3# Create a new email notifier
4response = requests.post('http://www.example.com/api/notifications/notifiers/email/1/patterns', 
5  json={
6  "name": "order_status_changed",
7  "description": "used for sending status changes",
8  "from_email": "info@hamgam.online",
9  "subject": "hamgam order status changed",
10  "body_text": "Order number {0} is in {1} status",
11  "body_html": null
12  },
13  headers={'Authorization': 'Token <your_api_key>'}
14)
15print(response.json())

🌐 Curl

1# Create a new email notifier
2curl -X POST "http://www.example.com/api/notifications/notifiers/email/1/patterns" \
3-H "Authorization: Token <your_api_key>" \
4-H "Content-Type: application/json" \
5-d '{
6  "name": "order_status_changed",
7  "description": "used for sending status changes",
8  "from_email": "info@hamgam.online",
9  "subject": "hamgam order status changed",
10  "body_text": "Order number {0} is in {1} status",
11  "body_html": null
12}'

Response Fields

Field	Type	Description
id	Integer	Unique ID of the email pattern.
name	String	Name of the email pattern (unique over the specific email notifier)
description	String	Extra descrtiption of the email pattern (nullable)
from_email	String	from email of the pattern (nullable)
subject	String	Subject of the email
body_text	String	Text body of the email pattern
body_html	String	Html body of the email pattern (nullable)
created_at	String (ISO 8601)	Timestamp when the email pattern was created.
updated_at	String (ISO 8601)	Timestamp when the email pattern was last updated.

Example Response

{
    "id": 3,
    "name": "order_status_changed",
    "description": "used for sending status changes",
    "from_email": "info@hamgam.online",
    "subject": "hamgam order status changed",
    "body_text": "Order number {0} is in {1} status",
    "body_html": null,
    "created_at": "2025-12-28T18:14:22.251792Z",
    "updated_at": "2025-12-28T18:14:22.251799Z"
}