Invite User
POST
/users/invitationsSend an invitation to someone to join your organisation.
The person will receive an email with a link to accept the invitation and set
up their account. You can pre-assign roles so they'll have the right access
from day one.
Invitations expire after 7 days. If someone hasn't accepted by then, you can
resend it.
When to use this
- Adding new team members to your organisation
- Inviting external collaborators with limited access
- Onboarding staff with pre-assigned roles
Request Body
Response
Invitation created successfully
Notes
ℹ️The invitation email is sent automatically-you don't need to send it yourself.
💡Assign roles when creating the invitation so the user has the right permissions immediately after accepting.
Code Samples
Create User Invitation using the TypeScript SDK:
import { BackstageClient } from '@ticketlayer/backstage';
const client = new BackstageClient({
organisationSlug: 'your-org',
});
client.setAccessToken('YOUR_ACCESS_TOKEN');
// Create userinvitation
const userinvitation = await client.userinvitation.create({
name: 'New UserInvitation',
// Add other required fields
});
console.log(`Created userinvitation with ID: ${userinvitation.id}`);