Skip to content

Create channel invite

POST
/api/channels/{channelId}/invites
curl --request POST \
--url http://localhost:3001/api/channels/example/invites \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{}'

Create a new invite link for a channel. Owner/admin only.

channelId
required
string

Channel ID

Invite creation parameters

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

OK

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

Unauthorized

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Forbidden

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Not Found

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}