Skip to main content

Interface: ConversationsRequestSharedInviteApproveArguments

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

Extends​

  • InviteID.Partial<ChannelID>.TokenOverridable

Properties​

channel_id?​

optional channel_id: string;

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

Description​

Encoded channel ID.

Inherited from​

Partial.channel_id

invite_id​

invite_id: string;

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

Description​

ID of the invite.

Inherited from​

InviteID.invite_id

is_external_limited?​

optional is_external_limited: boolean;

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

Description​

Whether the invited team will have post-only permissions in the channel. Will override the value on the requested invite.

message?​

optional message: object;

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

is_override​

is_override: boolean;
Description​

When true, will override the user specified message. Otherwise, text will be appended to the user specified message on the invite request.

text​

text: string;
Description​

Text to include along with the email invite.

Description​

Optional additional messaging to attach to the invite approval message.

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