View as Markdown
Ramp icon

Ramp ACTION

Create User Invite

Invite a new person to your Ramp organization by email — use this to onboard an employee who doesn't yet have a Ramp account. Requires their email, first and last name, and role (e.g. BUSINESS_USER); department, location, and direct manager are optional. Run List Departments and List Locations to find valid department/location IDs, and List Users to find a direct manager's user ID — each is a Ramp UUID, e.g. fffe6c22-698f-4dc5-b2b1-b35f86947d90. This is a deferred operation, so the invited user may not appear in List Users immediately; once they do, use Update User to change their role, department, location, or manager. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ramp account once, then configure and run Create User Invite 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: "ramp-create-user-invite",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ramp: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    firstName: "First Name",
  },
})

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 User Invite inputs
Property Type Description
email Email string
The employee's email address
Required
firstName First Name string
First name of the employee
Required
lastName Last Name string
Last name of the employee
Required
role Role string
The employee's role
Required
departmentId Department ID string
Unique identifier of a department — a Ramp UUID, e.g. fffe6c22-698f-4dc5-b2b1-b35f86947d90 (not a department name). Run the List Departments action to find valid IDs.
Optional
directManagerId Direct Manager ID string
Unique identifier of the employee's direct manager
Optional
locationId Location ID string
Unique identifier of a location — a Ramp UUID, e.g. 961c6f01-5719-4f4c-8fef-4096a031f32a (not a location name). Run the List Locations action to find valid IDs.
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
ramp-create-user-invite
Version
0.0.6
App
Ramp
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes