Update MS Teams

put

{protocol}://{server}{basePath}/accounts/{accountId}/msteams-elements/{elementId}

This API requires the Account Administrator role.

Update existing MS Teams element for an Account with required data.

Will trigger asynchronous updates, the status of which should be monitored via GET /msteams-elements/{elementId}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

elementId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

The unique 36 character internal id (uuid) that represents the Element.

Body Params

Refer MSTeamsElement model

MS Teams Element Model

name

string

required

length between 1 and 255

^[a-zA-Z0-9\p{L}\-\_\.\ ]+$

Name of the MS Teams Element

description

string

length ≤ 1024

(^$|^[a-zA-Z0-9\p{L}\-\_\.\ ]+$)

didNumbers

array of strings

length ≤ 2000

The did numbers in the E.164 format

didNumbers

domain

string

length between 3 and 255

^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$

Domain name configured for the MS Teams Element

status

string

enum

This field indicates the current status of an Element.

An explanation of the values is listed below:

SUCCESS - An Element was created/updated successfully.
FAILED - Operation on Element was failed.
IN_PROGRESS - Operation performed on an Element is in progress.

Allowed:

isChatEnabled

boolean

Defaults to true

Indicates whether the chat is enabled for any given MSTeams element.

clientId

string

length ≤ 255

The client id of the msteams client

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500All other application errors