Invite

Get Invite

GetAPIInvite

Returns an invite object for the given code.

import { getInvite } from "dressed";
const invite = await getInvite(code, params?);

Delete Invite

DeleteAPIInvite

Delete an invite.

import { deleteInvite } from "dressed";
await deleteInvite(code);

Info

Requires the MANAGE_CHANNELS permission on the channel this invite belongs to, or MANAGE_GUILD to remove any invite across the guild.

Get Target Users

GetAPIInviteTargetUsers

Gets the users allowed to see and accept this invite.

import { listTargetUsers } from "dressed";
const targetUsers = await listTargetUsers(code);

Update Target Users

PutAPIInviteTargetUsers

Updates the users allowed to see and accept this invite.

import { addTargetUser } from "dressed";
await addTargetUser(code, data);

Get Target Users Job Status

GetAPIInviteTargetUsersJobStatus

Processing target users from a CSV when creating or updating an invite is done asynchronously. This endpoint allows you to check the status of that job.

import { listTargetUsersJobStatus } from "dressed";
const targetUsersJobStatus = await listTargetUsersJobStatus(code);