Skip to content
Alter

Ramp: Manage a user's invite lifecycle — request body — body

Manage a user's invite lifecycle: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Manage a user's invite lifecycle — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parentThe invite action to perform. SCHEDULE creates or updates a scheduled invitation (requires `invitation_time`). DESCHEDULE cancels any pending scheduled invitation. SEND_NOW immediately sends the user’s invite.
One of: DESCHEDULE, SCHEDULE, SEND_NOW
invitation_timestringOptionalThe datetime at which the user should be invited. Required when `action` is SCHEDULE; ignored otherwise. Must be an ISO 8601 datetime with a timezone offset.
Format: date-time

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.

LinkedInTwitter