Skip to main content
Module

x/gesso/types/params.ts>CreateCommunicationChannelParams

A TypeScript API client for Canvas LMS
Peekoe/Gesso
Latest
interface CreateCommunicationChannelParams
import { type CreateCommunicationChannelParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
communicationchanneladdress: string

An email address or SMS number. Not required for “push” type channels.

optional
communicationchanneltype: string

Allowed values: email, sms, push

optional
communicationchanneltoken: string

A registration id, device token, or equivalent token given to an app when registering with a push notification provider. Only valid for “push” type channels.

optional
skipconfirmation: boolean

Only valid for site admins and account admins making requests; If true, the channel is automatically validated and no confirmation email or SMS is sent. Otherwise, the user must respond to a confirmation message to confirm the channel.