API

Every teams.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Channels

create

channels.create Create a new channel in a team Risk: write

await corsair.teams.api.channels.create({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`displayName`	`string`	Yes	—
`description`	`string`	No	—
`membershipType`	`standard \| private \| shared`	No	—
`isFavoriteByDefault`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`displayName`	`string`	No	—
`description`	`string`	No	—
`email`	`string`	No	—
`webUrl`	`string`	No	—
`membershipType`	`string`	No	—
`isFavoriteByDefault`	`boolean`	No	—
`createdDateTime`	`string`	No	—

delete

channels.delete Delete a channel [DESTRUCTIVE] Risk: destructive

await corsair.teams.api.channels.delete({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—

Output: empty object

get

channels.get Get details of a specific channel Risk: read

await corsair.teams.api.channels.get({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`displayName`	`string`	No	—
`description`	`string`	No	—
`email`	`string`	No	—
`webUrl`	`string`	No	—
`membershipType`	`string`	No	—
`isFavoriteByDefault`	`boolean`	No	—
`createdDateTime`	`string`	No	—

list

channels.list List channels in a team Risk: read

await corsair.teams.api.channels.list({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`filter`	`string`	No	—

Output

Name	Type	Required	Description
`@odata.context`	`string`	No	—
`@odata.nextLink`	`string`	No	—
`value`	`object[]`	Yes	—

value full type

{
  id: string,
  displayName?: string,
  description?: string | null,
  email?: string | null,
  webUrl?: string | null,
  membershipType?: string | null,
  isFavoriteByDefault?: boolean | null,
  createdDateTime?: string | null
}[]

update

channels.update Update a channel Risk: write

await corsair.teams.api.channels.update({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—
`displayName`	`string`	No	—
`description`	`string`	No	—
`isFavoriteByDefault`	`boolean`	No	—

Output: empty object

Chats

create

chats.create Create a new chat Risk: write

await corsair.teams.api.chats.create({});

Input

Name	Type	Required	Description
`chatType`	`oneOnOne \| group`	Yes	—
`topic`	`string`	No	—
`members`	`object[]`	Yes	—

members full type

{
  userId: string,
  roles?: string[]
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`topic`	`string`	No	—
`createdDateTime`	`string`	No	—
`lastUpdatedDateTime`	`string`	No	—
`chatType`	`string`	No	—
`webUrl`	`string`	No	—
`tenantId`	`string`	No	—

get

chats.get Get details of a specific chat Risk: read

await corsair.teams.api.chats.get({});

Input

Name	Type	Required	Description
`chatId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`topic`	`string`	No	—
`createdDateTime`	`string`	No	—
`lastUpdatedDateTime`	`string`	No	—
`chatType`	`string`	No	—
`webUrl`	`string`	No	—
`tenantId`	`string`	No	—

list

chats.list List chats for the current user Risk: read

await corsair.teams.api.chats.list({});

Input

Name	Type	Required	Description
`filter`	`string`	No	—
`top`	`number`	No	—

Output

Name	Type	Required	Description
`@odata.context`	`string`	No	—
`@odata.nextLink`	`string`	No	—
`value`	`object[]`	Yes	—

value full type

{
  id: string,
  topic?: string | null,
  createdDateTime?: string,
  lastUpdatedDateTime?: string,
  chatType?: string,
  webUrl?: string,
  tenantId?: string
}[]

listMessages

chats.listMessages List messages in a chat Risk: read

await corsair.teams.api.chats.listMessages({});

Input

Name	Type	Required	Description
`chatId`	`string`	Yes	—
`top`	`number`	No	—
`skipToken`	`string`	No	—

Output

Name	Type	Required	Description
`@odata.context`	`string`	No	—
`@odata.nextLink`	`string`	No	—
`value`	`object[]`	Yes	—

value full type

{
  id: string,
  replyToId?: string | null,
  etag?: string,
  messageType?: string,
  createdDateTime?: string,
  lastModifiedDateTime?: string,
  deletedDateTime?: string | null,
  subject?: string | null,
  summary?: string | null,
  chatId?: string | null,
  importance?: string,
  locale?: string,
  webUrl?: string | null,
  from?: {
    application?: {
    } | null,
    device?: {
    } | null,
    user?: {
      id?: string,
      displayName?: string | null,
      userIdentityType?: string
    } | null
  } | null,
  body?: {
    contentType?: text | html,
    content?: string
  },
  channelIdentity?: {
    teamId?: string,
    channelId?: string
  } | null,
  attachments?: {
  }[],
  mentions?: {
  }[],
  reactions?: {
  }[]
}[]

sendMessage

chats.sendMessage Send a message in a chat Risk: write

await corsair.teams.api.chats.sendMessage({});

Input

Name	Type	Required	Description
`chatId`	`string`	Yes	—
`body`	`object`	Yes	—
`importance`	`normal \| high \| urgent`	No	—

body full type

{
  content: string,
  contentType?: text | html
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`replyToId`	`string`	No	—
`etag`	`string`	No	—
`messageType`	`string`	No	—
`createdDateTime`	`string`	No	—
`lastModifiedDateTime`	`string`	No	—
`deletedDateTime`	`string`	No	—
`subject`	`string`	No	—
`summary`	`string`	No	—
`chatId`	`string`	No	—
`importance`	`string`	No	—
`locale`	`string`	No	—
`webUrl`	`string`	No	—
`from`	`object`	No	—
`body`	`object`	No	—
`channelIdentity`	`object`	No	—
`attachments`	`object[]`	No	—
`mentions`	`object[]`	No	—
`reactions`	`object[]`	No	—

from full type

{
  application?: {
  } | null,
  device?: {
  } | null,
  user?: {
    id?: string,
    displayName?: string | null,
    userIdentityType?: string
  } | null
}

body full type

{
  contentType?: text | html,
  content?: string
}

channelIdentity full type

{
  teamId?: string,
  channelId?: string
}

attachments full type

{
}[]

mentions full type

{
}[]

reactions full type

{
}[]

Members

add

members.add Add a member to a team Risk: write

await corsair.teams.api.members.add({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`userId`	`string`	Yes	—
`roles`	`owner \| member[]`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`displayName`	`string`	No	—
`userId`	`string`	No	—
`email`	`string`	No	—
`tenantId`	`string`	No	—
`roles`	`string[]`	No	—
`visibleHistoryStartDateTime`	`string`	No	—

get

members.get Get a specific team member Risk: read

await corsair.teams.api.members.get({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`membershipId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`displayName`	`string`	No	—
`userId`	`string`	No	—
`email`	`string`	No	—
`tenantId`	`string`	No	—
`roles`	`string[]`	No	—
`visibleHistoryStartDateTime`	`string`	No	—

list

members.list List members of a team Risk: read

await corsair.teams.api.members.list({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`filter`	`string`	No	—

Output

Name	Type	Required	Description
`@odata.context`	`string`	No	—
`@odata.nextLink`	`string`	No	—
`value`	`object[]`	Yes	—

value full type

{
  id: string,
  displayName?: string | null,
  userId?: string | null,
  email?: string | null,
  tenantId?: string | null,
  roles?: string[],
  visibleHistoryStartDateTime?: string | null
}[]

remove

members.remove Remove a member from a team [DESTRUCTIVE] Risk: destructive

await corsair.teams.api.members.remove({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`membershipId`	`string`	Yes	—

Output: empty object

Messages

delete

messages.delete Delete a channel message [DESTRUCTIVE] Risk: destructive

await corsair.teams.api.messages.delete({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—
`messageId`	`string`	Yes	—

Output: empty object

get

messages.get Get a specific channel message Risk: read

await corsair.teams.api.messages.get({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—
`messageId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`replyToId`	`string`	No	—
`etag`	`string`	No	—
`messageType`	`string`	No	—
`createdDateTime`	`string`	No	—
`lastModifiedDateTime`	`string`	No	—
`deletedDateTime`	`string`	No	—
`subject`	`string`	No	—
`summary`	`string`	No	—
`chatId`	`string`	No	—
`importance`	`string`	No	—
`locale`	`string`	No	—
`webUrl`	`string`	No	—
`from`	`object`	No	—
`body`	`object`	No	—
`channelIdentity`	`object`	No	—
`attachments`	`object[]`	No	—
`mentions`	`object[]`	No	—
`reactions`	`object[]`	No	—

from full type

{
  application?: {
  } | null,
  device?: {
  } | null,
  user?: {
    id?: string,
    displayName?: string | null,
    userIdentityType?: string
  } | null
}

body full type

{
  contentType?: text | html,
  content?: string
}

channelIdentity full type

{
  teamId?: string,
  channelId?: string
}

attachments full type

{
}[]

mentions full type

{
}[]

reactions full type

{
}[]

list

messages.list List messages in a channel Risk: read

await corsair.teams.api.messages.list({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—
`top`	`number`	No	—
`skipToken`	`string`	No	—

Output

Name	Type	Required	Description
`@odata.context`	`string`	No	—
`@odata.nextLink`	`string`	No	—
`value`	`object[]`	Yes	—

value full type

{
  id: string,
  replyToId?: string | null,
  etag?: string,
  messageType?: string,
  createdDateTime?: string,
  lastModifiedDateTime?: string,
  deletedDateTime?: string | null,
  subject?: string | null,
  summary?: string | null,
  chatId?: string | null,
  importance?: string,
  locale?: string,
  webUrl?: string | null,
  from?: {
    application?: {
    } | null,
    device?: {
    } | null,
    user?: {
      id?: string,
      displayName?: string | null,
      userIdentityType?: string
    } | null
  } | null,
  body?: {
    contentType?: text | html,
    content?: string
  },
  channelIdentity?: {
    teamId?: string,
    channelId?: string
  } | null,
  attachments?: {
  }[],
  mentions?: {
  }[],
  reactions?: {
  }[]
}[]

listReplies

messages.listReplies List replies to a channel message Risk: read

await corsair.teams.api.messages.listReplies({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—
`messageId`	`string`	Yes	—
`top`	`number`	No	—

Output

Name	Type	Required	Description
`@odata.context`	`string`	No	—
`@odata.nextLink`	`string`	No	—
`value`	`object[]`	Yes	—

value full type

{
  id: string,
  replyToId?: string | null,
  etag?: string,
  messageType?: string,
  createdDateTime?: string,
  lastModifiedDateTime?: string,
  deletedDateTime?: string | null,
  subject?: string | null,
  summary?: string | null,
  chatId?: string | null,
  importance?: string,
  locale?: string,
  webUrl?: string | null,
  from?: {
    application?: {
    } | null,
    device?: {
    } | null,
    user?: {
      id?: string,
      displayName?: string | null,
      userIdentityType?: string
    } | null
  } | null,
  body?: {
    contentType?: text | html,
    content?: string
  },
  channelIdentity?: {
    teamId?: string,
    channelId?: string
  } | null,
  attachments?: {
  }[],
  mentions?: {
  }[],
  reactions?: {
  }[]
}[]

reply

messages.reply Reply to a message in a channel Risk: write

await corsair.teams.api.messages.reply({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—
`messageId`	`string`	Yes	—
`body`	`object`	Yes	—
`importance`	`normal \| high \| urgent`	No	—

body full type

{
  content: string,
  contentType?: text | html
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`replyToId`	`string`	No	—
`etag`	`string`	No	—
`messageType`	`string`	No	—
`createdDateTime`	`string`	No	—
`lastModifiedDateTime`	`string`	No	—
`deletedDateTime`	`string`	No	—
`subject`	`string`	No	—
`summary`	`string`	No	—
`chatId`	`string`	No	—
`importance`	`string`	No	—
`locale`	`string`	No	—
`webUrl`	`string`	No	—
`from`	`object`	No	—
`body`	`object`	No	—
`channelIdentity`	`object`	No	—
`attachments`	`object[]`	No	—
`mentions`	`object[]`	No	—
`reactions`	`object[]`	No	—

from full type

{
  application?: {
  } | null,
  device?: {
  } | null,
  user?: {
    id?: string,
    displayName?: string | null,
    userIdentityType?: string
  } | null
}

body full type

{
  contentType?: text | html,
  content?: string
}

channelIdentity full type

{
  teamId?: string,
  channelId?: string
}

attachments full type

{
}[]

mentions full type

{
}[]

reactions full type

{
}[]

send

messages.send Send a message to a channel Risk: write

await corsair.teams.api.messages.send({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`channelId`	`string`	Yes	—
`body`	`object`	Yes	—
`subject`	`string`	No	—
`importance`	`normal \| high \| urgent`	No	—

body full type

{
  content: string,
  contentType?: text | html
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`replyToId`	`string`	No	—
`etag`	`string`	No	—
`messageType`	`string`	No	—
`createdDateTime`	`string`	No	—
`lastModifiedDateTime`	`string`	No	—
`deletedDateTime`	`string`	No	—
`subject`	`string`	No	—
`summary`	`string`	No	—
`chatId`	`string`	No	—
`importance`	`string`	No	—
`locale`	`string`	No	—
`webUrl`	`string`	No	—
`from`	`object`	No	—
`body`	`object`	No	—
`channelIdentity`	`object`	No	—
`attachments`	`object[]`	No	—
`mentions`	`object[]`	No	—
`reactions`	`object[]`	No	—

from full type

{
  application?: {
  } | null,
  device?: {
  } | null,
  user?: {
    id?: string,
    displayName?: string | null,
    userIdentityType?: string
  } | null
}

body full type

{
  contentType?: text | html,
  content?: string
}

channelIdentity full type

{
  teamId?: string,
  channelId?: string
}

attachments full type

{
}[]

mentions full type

{
}[]

reactions full type

{
}[]

Teams

create

teams.create Create a new team Risk: write

await corsair.teams.api.teams.create({});

Input

Name	Type	Required	Description
`displayName`	`string`	Yes	—
`description`	`string`	No	—
`visibility`	`public \| private`	No	—
`memberSettings`	`object`	No	—
`guestSettings`	`object`	No	—
`messagingSettings`	`object`	No	—
`funSettings`	`object`	No	—

memberSettings full type

{
  allowCreateUpdateChannels?: boolean,
  allowDeleteChannels?: boolean,
  allowAddRemoveApps?: boolean,
  allowCreateUpdateRemoveTabs?: boolean,
  allowCreateUpdateRemoveConnectors?: boolean
}

guestSettings full type

{
  allowCreateUpdateChannels?: boolean,
  allowDeleteChannels?: boolean
}

messagingSettings full type

{
  allowUserEditMessages?: boolean,
  allowUserDeleteMessages?: boolean,
  allowOwnerDeleteMessages?: boolean,
  allowTeamMentions?: boolean,
  allowChannelMentions?: boolean
}

funSettings full type

{
  allowGiphy?: boolean,
  giphyContentRating?: string,
  allowStickersAndMemes?: boolean,
  allowCustomMemes?: boolean
}

Output

Name	Type	Required	Description
`id`	`string`	No	—
`displayName`	`string`	No	—
`description`	`string`	No	—

delete

teams.delete Delete a team [DESTRUCTIVE] Risk: destructive

await corsair.teams.api.teams.delete({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—

Output: empty object

get

teams.get Get details of a specific team Risk: read

await corsair.teams.api.teams.get({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`displayName`	`string`	No	—
`description`	`string`	No	—
`internalId`	`string`	No	—
`classification`	`string`	No	—
`specialization`	`string`	No	—
`visibility`	`string`	No	—
`webUrl`	`string`	No	—
`isArchived`	`boolean`	No	—
`memberSettings`	`object`	No	—
`guestSettings`	`object`	No	—
`messagingSettings`	`object`	No	—
`funSettings`	`object`	No	—

memberSettings full type

{
  allowCreateUpdateChannels?: boolean,
  allowDeleteChannels?: boolean,
  allowAddRemoveApps?: boolean,
  allowCreateUpdateRemoveTabs?: boolean,
  allowCreateUpdateRemoveConnectors?: boolean
}

guestSettings full type

{
  allowCreateUpdateChannels?: boolean,
  allowDeleteChannels?: boolean
}

messagingSettings full type

{
  allowUserEditMessages?: boolean,
  allowUserDeleteMessages?: boolean,
  allowOwnerDeleteMessages?: boolean,
  allowTeamMentions?: boolean,
  allowChannelMentions?: boolean
}

funSettings full type

{
  allowGiphy?: boolean,
  giphyContentRating?: string,
  allowStickersAndMemes?: boolean,
  allowCustomMemes?: boolean
}

list

teams.list List teams the current user is a member of Risk: read

await corsair.teams.api.teams.list({});

Input

Name	Type	Required	Description
`filter`	`string`	No	—
`select`	`string`	No	—
`top`	`number`	No	—
`skipToken`	`string`	No	—

Output

Name	Type	Required	Description
`@odata.context`	`string`	No	—
`@odata.count`	`number`	No	—
`@odata.nextLink`	`string`	No	—
`value`	`object[]`	Yes	—

value full type

{
  id: string,
  displayName?: string,
  description?: string | null,
  internalId?: string | null,
  classification?: string | null,
  specialization?: string | null,
  visibility?: string | null,
  webUrl?: string | null,
  isArchived?: boolean | null,
  memberSettings?: {
    allowCreateUpdateChannels?: boolean,
    allowDeleteChannels?: boolean,
    allowAddRemoveApps?: boolean,
    allowCreateUpdateRemoveTabs?: boolean,
    allowCreateUpdateRemoveConnectors?: boolean
  } | null,
  guestSettings?: {
    allowCreateUpdateChannels?: boolean,
    allowDeleteChannels?: boolean
  } | null,
  messagingSettings?: {
    allowUserEditMessages?: boolean,
    allowUserDeleteMessages?: boolean,
    allowOwnerDeleteMessages?: boolean,
    allowTeamMentions?: boolean,
    allowChannelMentions?: boolean
  } | null,
  funSettings?: {
    allowGiphy?: boolean,
    giphyContentRating?: string,
    allowStickersAndMemes?: boolean,
    allowCustomMemes?: boolean
  } | null
}[]

update

teams.update Update team settings Risk: write

await corsair.teams.api.teams.update({});

Input

Name	Type	Required	Description
`teamId`	`string`	Yes	—
`displayName`	`string`	No	—
`description`	`string`	No	—
`visibility`	`string`	No	—
`memberSettings`	`object`	No	—
`guestSettings`	`object`	No	—
`messagingSettings`	`object`	No	—
`funSettings`	`object`	No	—

memberSettings full type

{
  allowCreateUpdateChannels?: boolean,
  allowDeleteChannels?: boolean,
  allowAddRemoveApps?: boolean,
  allowCreateUpdateRemoveTabs?: boolean,
  allowCreateUpdateRemoveConnectors?: boolean
}

guestSettings full type

{
  allowCreateUpdateChannels?: boolean,
  allowDeleteChannels?: boolean
}

messagingSettings full type

{
  allowUserEditMessages?: boolean,
  allowUserDeleteMessages?: boolean,
  allowOwnerDeleteMessages?: boolean,
  allowTeamMentions?: boolean,
  allowChannelMentions?: boolean
}

funSettings full type

{
  allowGiphy?: boolean,
  giphyContentRating?: string,
  allowStickersAndMemes?: boolean,
  allowCustomMemes?: boolean
}

Output: empty object

Overview

Plugins

Channels

create

delete

get

list

update

Chats

create

get

list

listMessages

sendMessage

Members

add

get

list

remove

Messages

delete

get

list

listReplies

reply

send

Teams

create

delete

get

list

update

Overview

Plugins

​Channels

​create

​delete

​get

​list

​update

​Chats

​create

​get

​list

​listMessages

​sendMessage

​Members

​add

​get

​list

​remove

​Messages

​delete

​get

​list

​listReplies

​reply

​send

​Teams

​create

​delete

​get

​list

​update

Channels

create

delete

get

list

update

Chats

create

get

list

listMessages

sendMessage

Members

add

get

list

remove

Messages

delete

get

list

listReplies

reply

send

Teams

create

delete

get

list

update