Skip to main content

Update A email Notifier Pattern

Update a email notifier pattern

HTTP Request​

PATCH/api/notifications/notifiers/email/:email_notifier_id/patterns/:id

Authorization​

Authorization

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

Path Parameters​

ParameterTypeRequiredDescription
email_notifier_idIntegerYesUnique ID of the email notifier
idIntegerYesUnique ID of the email notifier pattern

Request Body​

FieldTypeRequiredDescription
nameStringNoName of the email notifier pattern (unique over the specific email notifier)
descriptionStringNoExtra description about the email notifier pattern
from_emailStringNofrom_email address
subjectStringNoThe subject field of the email
body_textStringNoThe text body of the email pattern
body_htmlStringNoThe html body of the email pattern

Example Requests​

1import requests
2
3# Updates email notifier pattern
4response = requests.post('http://www.example.com/api/notifications/notifiers/email/1/patterns/9', 
5  json={
6    "subject": "your order status changed"
7  },
8  headers={'Authorization': 'Token <your_api_key>'}
9)
10print(response.json())

Response Fields​

FieldTypeDescription
idIntegerUnique ID of the email pattern.
nameStringName of the email pattern (unique over the specific email notifier)
descriptionStringExtra descrtiption of the email pattern (nullable)
from_emailStringfrom email of the pattern (nullable)
subjectStringSubject of the email
body_textStringText body of the email pattern
body_htmlStringHtml body of the email pattern (nullable)
created_atString (ISO 8601)Timestamp when the email pattern was created.
updated_atString (ISO 8601)Timestamp when the email pattern was last updated.

Response Example​

{
{
"id": 3,
"name": "order_status_changed",
"description": "used for sending status changes",
"from_email": "info@hamgam.online",
"subject": "Your 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:19:02.335166Z"
}
}