The ActivityMessage entity

Entity description

A message entity represents a communication sent from a business or staff member to a client via specified channels (email and/or SMS). The message includes content, call-to-action (CTA), and optional tracking parameters.

Properties

Name	Description	Type	Example
business_uid	The business that is sending the message	string	`56a78b56c`
staff_uid	The staff member sending the message	string	`5ya4gbwm2c3qoic8`
client_uid	The client receiving the message	string	`0c4ac9717ab26f56`
uid	The unique identifier of the message	string	`12a34b56c789`
activity_type	Activity category type (`invite`)	string	`invite`
activity_action	Action related to the activity type (`schedule`)	string	`schedule`
channels	Determines the message delivery channels (`email` or `sms`)	array	`["email", "sms"]`
message_text	The content of the message, including subject and body	object	See Message Text Properties below
cta_button_text	The text for the action button in the email	string	`Schedule now`
link_url_params	URL parameters for tracking the source and campaign of the message	object	See Link URL Parameters below
created_at	The creation date and time of the message in ISO 8601 format	string	`2024-01-01T09:00:00Z`
updated_at	The last updated date and time of the message in ISO 8601 format	string	`2024-03-20T12:34:56Z`

Message Text Properties

Name	Description	Type	Example
body	The main content of the message	string	`You are invited to schedule with us online.`
subject	A concise summary of the message content	string	`You can now schedule with us online!`

Link URL Parameters

Name	Description	Type	Example
utm_source	Identifies the source of traffic	string	`newsletter`
utm_campaign	Identifies the specific marketing campaign	string	`summer_sale`

Example

{
  "business_uid": "56a78b56c",
  "staff_uid": "5ya4gbwm2c3qoic8",
  "client_uid": "0c4ac9717ab26f56",
  "uid": "12a34b56c789",
  "activity_type": "invite",
  "activity_action": "schedule",
  "message_text": {
    "body": "You are invited to schedule with us online.",
    "subject": "You can now schedule with us online!"
  },
  "cta_button_text": "Schedule now",
  "link_url_params": {
    "utm_source": "newsletter",
    "utm_campaign": "summer_sale"
  },
  "channels": ["email", "sms"],
  "created_at": "2024-01-01T09:00:00Z",
  "updated_at": "2024-03-20T12:34:56Z"
}