View as Markdown
Xola icon

Xola ACTION

Create Experience Schedule

Creates a new schedule for an experience. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Xola account once, then configure and run Create Experience Schedule 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: "xola-create-experience-schedule",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    xola: { authProvisionId: "apn_xxxxxxx" },
    sellerId: "Seller ID",
    experienceId: "Experience ID",
  },
})

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 Experience Schedule inputs
Property Type Description
sellerId Seller ID string
The unique identifier of the seller
Required Dynamic
experienceId Experience ID string
The unique identifier of the experience
Required Dynamic
name Name string
Name for this schedule
Required
type Type string
Can be for an open (available) schedule or a blackout schedule
Required
days Days string[]
Days of week
Optional
departure Departure string
Whether departure time is fixed or varies
Optional
times Times string[]
Start times in HHMM format (e.g., 900 = 9:00 AM, 1400 = 2:00 PM, 1800 = 6:00 PM).
Optional
priceDelta Price Delta string
Price adjustment for this schedule (can be positive or negative). Only available when Type is available
Optional
repeat Repeat string
When and how the schedule should repeat. Options are weekly (repeat the same schedule every week until End, if specified), or custom, which can be used in conjunction with Dates to specify individual days for the schedule to run
Optional
start Start string
Start date of the schedule in ISO 8601 format. Example: 2024-01-01T00:00:00Z
Optional
end End string
End date of the schedule in ISO 8601 format. Example: 2024-12-31T23:59:59Z
Optional
dates Dates string[]
Specific dates when this schedule applies. Only available when Repeat is custom. Format is YYYY-MM-DD. Cannot be combined with End.
Optional

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
xola-create-experience-schedule
Version
0.0.1
App
Xola
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes