Skip to main content

Interface: ConversationsInviteArguments

Defined in: packages/web-api/src/types/request/conversations.ts:109

Extends​

  • Channel.Users.TokenOverridable

Properties​

channel​

channel: string;

Defined in: packages/web-api/src/types/request/conversations.ts:15

Description​

ID of conversation.

Inherited from​

Channel.channel

force?​

optional force: boolean;

Defined in: packages/web-api/src/types/request/conversations.ts:114

Description​

When set to true and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs. Defaults to false.

token?​

optional token: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

users​

users: string;

Defined in: packages/web-api/src/types/request/conversations.ts:49

Description​

A comma separated list of user IDs. Up to 1000 users may be listed.

Inherited from​

Users.users