POST api2/notification.json

Get Company Notifications and/or send e-mail

Request Information

URI Parameters

None.

Body Parameters

API.Models.NotificationRequest

Name	Description	Type	Additional information
customer_id	Find customer by ID. Required if no customer_token, customer_email is defined.	integer	None.
customer_token	Find customer Customer by Token. Required if no customer_id, customer_email is defined.	string	None.
customer_email	Find customer Customer by email. Required if no customer_id, customer_token is defined.	string	None.
template_type	Notification type.	Enums.CompanyMessageTemplateType	None.
product_id	Product ID, required if no company_id is defined.	integer	None.
company_id	Company ID, required if no product_id is defined.	integer	None.
store	Store email in customer support	boolean	None.
to	Send email to. Required if "send_mail" is true.	string	None.
from	Sender email. Required if "send_mail" is true.	string	None.
send_mail	Email will be sent if set to true.	boolean	None.
content_only	Without Design Master	boolean	None.
bcc	List of BCC's	Collection of string	None.
placeholder	Replace text in notification	Dictionary of string [key] and string [value]	None.
subject	E-mail Subject Required if "template_type" is None	string	None.
message	E-mail Message Required if "template_type" is None	string	None.

Request Formats

{
  "customer_id": 1,
  "customer_token": "sample string 2",
  "customer_email": "sample string 3",
  "template_type": "None",
  "product_id": 4,
  "company_id": 5,
  "store": true,
  "to": "sample string 7",
  "from": "sample string 8",
  "send_mail": true,
  "content_only": true,
  "bcc": [
    "sample string 1",
    "sample string 2"
  ],
  "placeholder": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "subject": "sample string 11",
  "message": "sample string 12"
}

Response Information

Resource Description

API.Models.NotificationResponse

Name	Description	Type	Additional information
message	Message	string	None.
subject	Subject	string	None.
from	From	string	None.
bcc	BCC's	Collection of string	None.

Response Formats

{
  "message": "sample string 1",
  "subject": "sample string 2",
  "from": "sample string 3",
  "bcc": [
    "sample string 1",
    "sample string 2"
  ]
}