# TeamsApi
All URIs are relative to https://api.salestim.io/api/v1.0
Method | HTTP request | Description |
---|---|---|
addTeamMember | POST /teams/{teamId}/members | Add a team member |
archiveTeam | POST /teams/{teamId}/archive | Archive a team |
createTeamChannel | POST /teams/{teamId}/channels | Create a new team channel |
createTeamChannelTab | POST /teams/{teamId}/channels/{channelId}/tabs | Create a new team channel tab |
createTeamProvisioningJob | POST /teams/provisioning | Create a new team based on a template |
deleteTeam | DELETE /teams/{teamId} | Delete a team |
getTeam | GET /teams/{teamId} | Get a team |
getTeamChannelTabs | GET /teams/{teamId}/channels/{channelId}/tabs | Get team channel tabs |
getTeamChannels | GET /teams/{teamId}/channels | Get team channels |
getTeamPrimaryChannel | GET /teams/{teamId}/channels/primary | Get the primary channel of a team |
unarchiveTeam | POST /teams/{teamId}/unarchive | Unarchive a team |
updateTeam | PATCH /teams/{teamId} | Update a team |
# addTeamMember
ApiError addTeamMember(teamId, TeamMembershipPayload)
Add a team member
Add a team member. TIER 2️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
TeamMembershipPayload | TeamMembershipPayload | TeamMembershipPayload. |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# archiveTeam
archiveTeam(teamId, body)
Archive a team
Archive a team. TIER 1️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
body | Object | In the request, you may optionally include the shouldSetSpoSiteReadOnlyForMembers parameter in a JSON body. This optional parameter defines whether to set permissions for team members to read-only on the SharePoint Online site associated with the team. Setting it to false or omitting the body altogether will result in this step being skipped. | [optional] |
# Return type
null (empty response body)
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# createTeamChannel
TeamChannel createTeamChannel(teamId, body)
Create a new team channel
Create a new team channel. TIER 2️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
body | Object | A TeamChannelPayload object describing the channel to create. |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# createTeamChannelTab
TeamChannelTab createTeamChannelTab(teamId, channelId, body)
Create a new team channel tab
Create a new team channel tab. TIER 2️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
channelId | String | The team channel ID. | [default to null] |
body | Object | A TeamChannelTabPayload object describing the tab to create. |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# createTeamProvisioningJob
Job createTeamProvisioningJob(TeamProvisioningRequest)
Create a new team based on a template
Create a new team provisioning job. TIER 1️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
TeamProvisioningRequest | TeamProvisioningRequest | A TeamProvisioningRequest object describing the job to execute. |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# deleteTeam
deleteTeam(teamId)
Delete a team
Delete a team. TIER 3️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
# Return type
null (empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getTeam
Team getTeam(teamId)
Get a team
Get detailed information about a team. TIER 3️⃣ | ROLES - AUTHORIZED_APP, INTEGRATION_MANAGER, GOVERNANCE_MANAGER, TEAMS_SERVICE_ADMIN, GLOBAL_ADMIN.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getTeamChannelTabs
List getTeamChannelTabs(teamId, channelId)
Get team channel tabs
Get team channel tabs. TIER 3️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
channelId | String | The team channel ID. | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getTeamChannels
List getTeamChannels(teamId)
Get team channels
Get team channels. TIER 3️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getTeamPrimaryChannel
TeamChannel getTeamPrimaryChannel(teamId)
Get the primary channel of a team
Get the primary channel of a team. TIER 3️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# unarchiveTeam
unarchiveTeam(teamId)
Unarchive a team
Unarchive a team. TIER 1️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
# Return type
null (empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# updateTeam
updateTeam(teamId, body)
Update a team
Update a team. TIER 2️⃣ | ROLES - AUTHORIZED_APP, INTEGRATION_MANAGER, GOVERNANCE_MANAGER, TEAMS_SERVICE_ADMIN, GLOBAL_ADMIN.
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
teamId | String | The team ID. | [default to null] |
body | Object | Supply a JSON representation of team object. |
# Return type
null (empty response body)
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json