Skip to main content
POST
Create invitations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create invitation request payload

type
enum<string>
required

Type of invitation to create

Available options:
communityMemberInvite,
livestreamCohostInvite
Example:

"communityMemberInvite"

targetType
enum<string>
required

Type of target entity

Available options:
community,
room
Example:

"community"

targetId
string
required

ID of the target entity (community, group, etc.)

Required string length: 1 - 900
Example:

"68583742eae5300158b6d144"

userIds
string[]
required

Array of user IDs to invite

Required array length: 1 - 1000 elements

User ID to invite

Required string length: 1 - 50
Example:

Response

Create invitation response

invitations
object[]

Array of created invitation objects

users
object[]

User details for invited users