API Reference

Create an ActivityMessage

post
https://api.vcita.biz/v3/communication/activity_messages

Overview

Create an ActivityMessage Available for Staff, App, and Directory tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The unique identifier of the business that is sending the message

string

The unique identifier of the staff that is sending the message

string
required

The unique identifier of the client the message is sent to

string
enum
required

Activity category type from a closed list.

Allowed:
string
enum
required

Action related to the activity type property.

Allowed:
channels
array of strings
required

Determines if the message should be sent via email or/and SMS.

channels*
message_text
object
string

In the Email, this text will appear on the button embedded in the email message

link_url_params
object

The parameters for the Email action button or SMS link. for example: { "utm_source": "newsletter", "utm_campaign": "summer_sale" }

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago