LightSpeed VT ACTION
Create New User
Creates a new user in the LightSpeed VT system. See the documentation
- Action
- Writes data
- Destructive
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's LightSpeed VT account once, then configure and run Create New User 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: "lightspeed_vt-create-new-user",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
lightspeed_vt: { authProvisionId: "apn_xxxxxxx" },
isActive: true,
locationId: "Location Id",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "lightspeed_vt-create-new-user",
"configured_props": {
"lightspeed_vt": { "authProvisionId": "apn_xxxxxxx" },
"isActive": true,
"locationId": "Location Id"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "lightspeed_vt",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "lightspeed_vt-create-new-user",
arguments: {
isActive: true,
locationId: "Location Id",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
isActive Is Active | boolean | Set to return active or inactive users only. Optional |
locationId Location Id | string | Specifies the location Id. Required Dynamic |
username Username | string | The username of the new user. Required |
password Password | string | The password for the new user. Required |
email Email | string | The email of the new user. Required |
firstName First Name | string | The first name of the new user. Required |
lastName Last Name | string | The last name of the new user. Required |
middleName Middle Name | string | The middle name of the new user. Optional |
title Title | string | The title of the new user. Optional |
gender Gender | string | The gender of the new user. Optional |
dob DOB | string | Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's date of birth. Optional |
language Language | string | Default: en-us - Language to set for user - Any valid ISO 639-1 code with region. Optional |
accessLevel Access Level | integer | The access level for the new user. See Access Levels Definition Required |
companyName Company Name | string | The company of the new user. Optional |
teamId Team Id | string | Id for team assigned to user. Optional Dynamic |
jobPositionId Job Position Id | string | Id for job position assigned to user. Optional Dynamic |
hireDate Hire Date | string | Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's hiring date. Optional |
startDate Start Date | string | Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's starting date. Optional |
releaseDate Release Date | string | Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's release date. Optional |
expireDate Expire Date | string | Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's account expiration date. Optional |
affiliateId Affiliate Id | string | Affiliate Id associated with creation of user's account. Optional |
vendorId Vendor Id | string | Custom vendor Id associated with creation of user's account. Optional |
misc1 Misc 1 | string | Miscellaneous info field 1. Optional |
misc2 Misc 2 | string | Miscellaneous info field 2. Optional |
phone1 Phone 1 | string | User's phone number 1. Optional |
phone2 Phone 2 | string | User's phone number 2. Optional |
contentRole Content Role Id | integer[] | List of content roles Ids. Optional Dynamic |
lockUsername Lock Username | boolean | Restricts user from changing its username. Optional |
lockUsernamePassword Lock Username Password | boolean | Restricts user from changing its username and password. Optional |
forcePasswordUpdate Force Password Update | boolean | Forces user to update its password upon first sign in. Optional |
updateMyProfile Update My Profile | boolean | Restricts user from updating its profile. Optional |
manageUsers Manage Users | boolean | Restricts user from managing other users. Optional |
billingFrequency Billing Frequency | integer | Use to specify the billing schedule frequency in months. Required if your API settings are set to require this parameter. Optional |
grossFeeCharged Gross Fee Charged | string | Use to specify the fee per user. Required if your API settings are set to require this parameter. Optional |
promoCode Promo Code | string | Promo code used during user's account creation. Optional |
address1 Address 1 | string | User's address line 1. Optional |
address2 Address 2 | string | User's address line 2. Optional |
city City | string | User's city. Optional |
state State | string | User's state or province. Optional |
zip ZIP | string | User's zip or postal code. Optional |
country Country | string | User's country. Optional |
mobile Mobile | string | User's mobile phone. Optional |
addPhone Add Phone | string | User's phone number 3. Optional |
cellCountry Cell Country | string | User's mobile phone country code. Optional |
handle Handle | string | This is the Display Name under My Profile. View Support Article. Optional |
hometown Hometown | string | User's hometown. Optional |
aboutMe About Me | string | A short description about the user. Optional |
facebook Facebook | string | Facebook username. Optional |
linkedIn LinkedIn | string | LinkedIn username. Optional |
instagram Instagram | string | Instagram username. Optional |
twitter Twitter | string | Twitter handle. Optional |
youtube Youtube | string | Youtube username. Optional |
tikTok TikTok | string | TikTok username. 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
- lightspeed_vt-create-new-user
- Version
- 0.0.2
- App
- LightSpeed VT
- Authentication
- API key
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗