Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Create a user invite — request body — body

Referenced models: Create a user invite — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a user invite — response body

Referenced models: Create a user invite — response body

Create a user invite — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
department_idstringOptionalUnique identifier of the employee's department
Format: uuid
direct_manager_idstringOptionalUnique identifier of the employee's direct manager
Format: uuid
emailstringRequired within parentThe employee's email address
Format: email
first_namestringRequired within parentFirst name of the employee
Maximum length: 255
idempotency_keystringRequired within parentan 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_draftbooleanOptionalWhen 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_managerbooleanOptionalWhether the employee is a manager
last_namestringRequired within parentLast name of the employee
Maximum length: 255
location_idstringOptionalUnique identifier of the employee's location
Format: uuid
rolestringRequired within parentThe 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_dateJSONOptional
scheduled_deactivation_date (anyOf 1)stringAlternativeThe 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)nullAlternative
Create a user invite — response body
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentID of the deferred task.
Format: uuid

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.