Docs Search

Recommended

Pivot Mobile and Desktop App

The Infinite Canvas Block

Audio and Video Messages

Making the Most of Your Personal Space

Integrating with Pivot using Zapier

Switch to light / dark version

DOCS

Welcome to Pivot

Vision and Purpose Platform Basics Organizations Accounts Your Personal Space Notifications and Settings Desktop Apps Mobile Apps

The World of Blocks

Introduction to Block-Based Creativity Pages and Basic Blocks Uploading Files, Images, and Videos Templates, Buttons, and Synced Blocks Infinite Canvases Databases Charts Forms Calendars and Events Goals Blocks for Education (Assignment, Grading and Rubrics)Blocks in Rooms Rooms, Polls, and Audio and Video Messages Block Sharing and Publishing Quizzes

Rooms

Introduction to Rooms Direct Rooms Audio Rooms Video Rooms Chat Rooms Audio and Video Messages Post Rooms Streaming Rooms Breakout Groups Room Recordings Pivot AI Chat

Administration

Space

Managing Members and Roles Paid Space Memberships Space Analytics Space Sharing

Organization

Enterprise Security Settings Configuring SAML Single-Sign-On SCIM User Management Subscriptions and Billing Introduction to Organizations

Integrations

Google and Outlook Calendars Zapier

Pivot Accelerate

Pivot's Vision and Values Getting Started with Pivot Real-time Communication Tools Assistance and Resources Building Your Collaborative Environment

REST API

Authentication Changelog Getting Started with the Pivot API Authorization

API REFERENCE

Blocks

Delete a block response attachmentdelete Delete a block responsedelete Update a block responsepatch Create an attachment for a block responsepost Send a block responsepost Get block by its IDget Get block responsesget Create a response for a blockpost

Groups

Get groupsget Get group membersget Create group memberspost Delete group membersdelete

Spaces

Create a new spacepost Get spacesget Update a spacepatch Add a group to a spacepost Hide a spacepatch Invite users to a spacepost Create space memberspost Delete space memberdelete Update a space memberpatch Get space membersget Get space rolesget Create a new space rolepost Get room blocksget

Users

Get user contextget Delete userdelete Delete verified user or remove from organizationdelete

Rooms

Get roomget Invite users to a roompost Create room memberspost Get room messagesget Get message repliesget Get active participants in a room and their messages statsget

BUILDING PIVOT APPS

Building Block Apps Building Link Previews Building Room Bots Creating Public Integrations Introduction User Authorization

Dashboard pivot.app Support

post /v1/rooms/{roomId}/invites

Invite users to a room

path params

roomIdstring required

Request body

invite Object

INVITE PROPERTIES

emails Array of String required

role String ENUM required

ROLE ENUM VALUES

ROOM_ROLE_UNSPECIFIED ROOM_ROLE_HOST ROOM_ROLE_PARTICIPANT

Responses

200

response body

object

invites Array

Array of Invite

id String

email String

status String

default

response body

object

code Integer The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message String A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details Array

Array of GoogleProtobufAny

@type String The type of the serialized message.

Was this guide helpful?

Get room

Create room members

On this page

© 2025 Pivot Technologies. All rights reserved. The name “Pivot” is a registered trademark of Pivot Technologies.

Login Blog Docs Contact

Security Careers Open source Brand

Legal Privacy policy Terms of service

Switch to light / dark version

All systems normal.