# Webpush message model

You can create a webpush message. These messages will be used in a webpush campaign.

# Input fields (Create / Update)

Attributes	Type	Required	Description
title	string	yes	A title of a web push message.
body	string	yes	A content of a web push message.
url	string	no	A URL of a web push message.
require_interaction	boolean	no	A flag defining if a notification should remain active until the user clicks or dismisses it, rather than closing automatically.
doughnut_title	string	no	Action button 1 label.
doughnut_url	string	no	Action button 1 URL.
coffee_title	string	no	Action button 2 label.
coffee_url	string	no	Action button 2 URL.
icon	string	no	A URL of image inside a web push message.
badge	string	no	A URL of image inside a web push message (known as a Big photo). Only works on Windows.

# Response fields (GET)

In GET responses, message fields are returned with a message_ prefix:

Response field	Type	Description
id	integer	Unique identifier for the message variant.
name	string	Message variant name (e.g. "A").
message_id	integer	Internal message identifier.
message_title	string	Title of the web push message.
message_body	string	Body text of the web push message.
message_badge	string	Badge image URL, or null.
message_icon	string	Icon image URL, or null.
message_url	string	Click-through URL of the notification.
message_require_interaction	boolean	Whether the notification requires user interaction.
message_doughnut_title	string	Action button 1 label.
message_doughnut_url	string	Action button 1 URL.
message_actions	boolean	Whether action buttons are configured.
message_coffee_title	string	Action button 2 label.
message_coffee_url	string	Action button 2 URL.