View as Markdown
Upsales icon

Upsales ACTION

Create Appointment

Creates a new appointment in Upsales. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Upsales account once, then configure and run Create Appointment from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "upsales-create-appointment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    upsales: { authProvisionId: "apn_xxxxxxx" },
    clientId: 10,
    users: ["Users"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Appointment inputs
Property Type Description
clientId Client ID integer
The client ID to associate with the appointment
Required
users Users string[]
User IDs to associate with the appointment
Optional Dynamic
date Date string
The date of the appointment. In ISO 8601 format. e.g. 2026-04-16
Required
endTime End Time string
The end time of the appointment. In ISO 8601 format. e.g. 11:00:00
Required
description Description string
The description of the appointment
Optional
activityType Activity Type ID string
The activity type's unique ID
Required Dynamic
contactIds Contact IDs string[]
The contact IDs to associate with the appointment
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
upsales-create-appointment
Version
0.0.1
App
Upsales
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes