Create Channel Invite.md 765 B


title: Create Channel Invite category: Channel

order: 17

createChannelInvite

$client->channel->createChannelInvite($parameters);

Description

Create a new invite object for the channel. Only usable for guild channels. Requires the CREATE_INSTANT_INVITE permission. All JSON paramaters for this route are optional, however the request body is not. If you are not sending any fields, you still have to send an empty JSON object ({}).

Parameters

Name Type Required Default
channel.id snowflake true null
max_age integer false 86400
max_uses integer false 0
temporary bool false null
unique bool false null

Response

Returns an invite object.

Can Return:

  • invite