Ramp: Create a user invite
Ramp user.postUserCreationDeferredTask: arguments, response, policy and SDK examples.
← User operations · Get started
Operation ramp.post_user_creation_deferred_task
Provider route: POST /developer/v1/users/deferred. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["user"]["postUserCreationDeferredTask"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.user.postUserCreationDeferredTask(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.user.post_user_creation_deferred_task(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Create a user invite — request body — body |
Referenced models: Create a user invite — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a user invite — response body |
Referenced models: Create a user invite — response body
Schemas
Section titled “Schemas”Create a user invite — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department_id | string | Optional | Unique identifier of the employee's department Format: uuid |
direct_manager_id | string | Optional | Unique identifier of the employee's direct manager Format: uuid |
email | string | Required within parent | The employee's email address Format: email |
first_name | string | Required within parent | First name of the employee Maximum length: 255 |
idempotency_key | string | Required within parent | an idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. To avoid collisions, we encourage clients to use random generated UUIDs. |
is_draft | boolean | Optional | When set to true, the user will be created as a draft. Draft users are not sent an invite email and must be explicitly activated later, which can be accomplished in-app or via the `POST /users/<string:user_id>/invite` resource. |
is_manager | boolean | Optional | Whether the employee is a manager |
last_name | string | Required within parent | Last name of the employee Maximum length: 255 |
location_id | string | Optional | Unique identifier of the employee's location Format: uuid |
role | string | Required within parent | The employee's role; It could be one of the following values: Admin, Cardholder, Bookkeeper; Note that Owner is not a invitable role. One of: AUDITOR, BUSINESS_ADMIN, BUSINESS_BOOKKEEPER, BUSINESS_OWNER, BUSINESS_USER, GUEST_USER, IT_ADMIN |
scheduled_deactivation_date | JSON | Optional | |
scheduled_deactivation_date (anyOf 1) | string | Alternative | The date when the user is scheduled to be deactivated. For guest users, this will automatically be set to 6 months from the invite creation date unless explicitly set to null. Cannot be set for admins or owners. Format: date |
scheduled_deactivation_date (anyOf 2) | null | Alternative |
Create a user invite — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | ID of the deferred task. Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_user_creation_deferred_task. Catalog operation: post_user_creation_deferred_task. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["users:write"]