About Space Invitations

What are Space Invitations?

Space Invitations allow you to invite users to your Space. Users are invited by email. Once they follow the invitation link and are signed in, they will be redirected to the Space passing along the invitation token. Commonly, the Space will then ask the user whether to accept the invitation or not.

Related guide: Space Invitations

Endpoints

POST https://api.cirro.io/v2/space_invitations POST https://api.cirro.io/v2/space_invitations/:id/expire

The Space Invitation object

Attributes

Attribute	Type	Description
`id`	`string`	The unique identifier of the space invitation.
`object`	`string`	Always "space_invitation"
`token`	`string`	The invitation token.
`subject`	`string`	What the user is being invited to.
`email`	`string`	The email of the invited user.
`name`	`string`	The name of the invited user.
`inviter_name`	`number`	The name of the person inviting the user.
`skip_background_check`	`boolean`	Whether to skip background checks for the invited user. If `true` the user will not be asked for their country and birthdate during signup.
`message`	`string`	An (optional) message added to the invitation email.
`expires_at`	`number`	The date/time this invitation will expire as a UNIX timestamp.

Example

{
  "id": "13",
  "object": "space_invitation",
  "token": "n30w87rn08w37rwgh0o387rnw",
  "subject": "A-Team",
  "email": "[email protected]",
  "name": "New User",
  "inviter_name": "Inviter Name",
  "skip_background_check": false,
  "message": "Invitation Message",
  "expires_at": 1652285764
}