Stirling PDF icon

Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

Invite → Generate Invite Link

AI-generated

Summary

Generate an invite link to a Stirling PDF team with specified parameters, optionally trigger sending the invite email, and receive the generated link in response.

Inputs

  • Email (required) — The email address to which the invite will be associated and optionally sent.
  • Role (required) — The role assigned to the invitee, e.g., 'ROLE_USER'.
  • Team Id (required) — The numeric identifier of the team to which the invite applies.
  • Expiry Hours — The number of hours after which the invite link will expire; zero means no expiration.
  • Send Email — Boolean flag to indicate if an invite email should be sent to the specified email.
  • Frontend Base Url — Base URL used in constructing the invite link sent to the user.

Output shape

a single record containing the generated invite link and associated metadata.

The response includes the invite link URL; additional fields depend on API details. Errors or failures are returned as standard error responses.

Links

Discussion