View as Markdown
Illumidesk icon

Illumidesk ACTION

Invite Course Member

Invites a user to a selected course. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Illumidesk account once, then configure and run Invite Course Member 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: "illumidesk-invite-course-member",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    illumidesk: { authProvisionId: "apn_xxxxxxx" },
    campusSlug: "Campus Slug",
    courseSlug: "Course 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.

Invite Course Member inputs
Property Type Description
campusSlug Campus Slug string
The slug for the campus
Required Dynamic
courseSlug Course ID string
The slug for the course
Required Dynamic
email Email string
Email address of the member to invite
Required
role Role string
Role of the member in the course
Required
permission Permission string
Permission of the member in the course. Required for Role instructor.
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
illumidesk-invite-course-member
Version
0.0.3
App
Illumidesk
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes