Space Invitations
Create a Space Invitations
POST
https://cirro.io/api/v2/space_invitationsParameters
| Parameter | Type | Note | |
|---|---|---|---|
subject | required | string | |
email | required | string | |
name | required | string | |
inviter_name | required | string | |
skip_background_check | boolean | Default: false | |
message | string | ||
expires_in | number | Default: 7 | |
notification_topic | string OR number | use it for the invitation email (by ID or name). Default: space_invitation (space's system-level topic) |
Description
Returns the Space Invitation object if creation succeeded. Returns an error if creation failed.
Please see our guide on Space Invitations to learn more about the parameters and their usage in different scenarios.
Example
1client = CirroIOV2::Client.new(...)
2client.SpaceInvitation.create(
3 email: "[email protected]",
4 name: "New User",
5 subject: "A-Team",
6 inviter_name: "Inviter Name",
7 skip_background_check: false,
8 message: "Welcome to the A-Team!",
9 expires_in: 7
10)