Create an ActivitySource

Overview

Create an ActivitySource for the business.

utm_params is stored only for businesses with the sales account feature.

Available for Staff Tokens.

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

The fields of the new ActivitySource. Every field is optional.

string | null

The name of the source the activity came from. A free string, not an enum: integrations, apps and businesses write their own values (e.g., "initiated_by_staff", "website", "client_portal", "automatic_messages", "campaign", "automation", "api", "call", "rwg_redirect", "AI Receptionist", "square", "unknown").

string | null

The channel inside the source, for example the widget or the medium. A free string, not an enum: integrations and businesses write their own values (e.g., "scheduler_widget", "contact_form", "client_portal_widget", "email", "sms", "csv_import", "manual_contact", "square", "Paid Search"). Most sources have no channel.

string | null

The campaign of the source, in the UTM sense: the label of what sent the link to the client. Its meaning depends on source_name: a message template, a campaign uid, or the business phone number (e.g., "message_request", "client_reminder", "scheduled_payments", "+15551234567"). Null for most sources.

string | null

The page where the activity started: the business website page with a widget, the client portal page, the online scheduling page, or the link of a message. Longer values are cut to 255 characters.

utm_params
object | null

The marketing parameters of the visit that created the source: the five UTM parameters and the Google Ads click identifier (gclid). Stored only for businesses with the sales account feature. Other keys are rejected.

Responses

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