Operations (sample payloads)
Main operations
Add member to group
Adds a member to an Office 365 group (unified), a dynamic group or security group. Sample Input
\{
"group_id": "12345678-1234-1234-1234-123456789012",
"user_id": "87654321-4321-4321-4321-210987654321"
\}
Sample Output
Add owner to group
Adds an owner of an Office 365 group (unified), a dynamic group or security group. Sample Input
\{
"group_id": "12345678-1234-1234-1234-123456789012",
"user_id": "87654321-4321-4321-4321-210987654321"
\}
Sample Output
{
"success": true
}
Add tab to channel
Adds a tab to a channel. Sample Input
{
"app_id": "12345678-90ab-cdef-ghij-klmnopqrstuv",
"group_id": "87654321-fedc-ba09-8765-432109876543",
"channel_id": "19:abcdef0123456789@thread.tacv2",
"display_name": "Project Tracker",
"configuration": \{
"entity_id": "projectTracker123",
"content_url": "https://example.com/project-tracker",
"remove_url": "https://example.com/remove-tab",
"website_url": "https://example.com/project-tracker-web"
\}
}
Sample Output
{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#teams('87654321-fedc-ba09-8765-432109876543')/channels('19:abcdef0123456789@thread.tacv2')/tabs/$entity",
"id": "01234567-89ab-cdef-0123-456789abcdef",
"displayName": "Project Tracker",
"webUrl": "https://teams.microsoft.com/l/tab/01234567-89ab-cdef-0123-456789abcdef?label=Project+Tracker&tenantId=98765432-10fe-dcba-9876-543210fedcba",
"configuration": \{
"entityId": "projectTracker123",
"contentUrl": "https://example.com/project-tracker",
"removeUrl": "https://example.com/remove-tab",
"websiteUrl": "https://example.com/project-tracker-web"
\}
}
Archive team
Archives a team (makes it read-only). Sample Input Sample Output
Clone team
Clones a team and its corresponding group. Sample Input Sample Output
{
"success": true
}
Create adaptive card
Create an adaptive card in a channel. Sample Input Sample Output
\{
"success": true,
"activity_id": "1234567890.1234567890"
\}
Create channel
Creates a new channel in a Microsoft Team. Sample Input Sample Output
Create chat message
Create a chat message in a channel. Sample Input Sample Output
{
"id": "1234567890",
"replyToId": null,
"etag": "W/\"datetime'2023-05-15T14:30:00.1234567Z'\"",
"messageType": "message",
"createdDateTime": "2023-05-15T14:30:00.1234567Z",
"lastModifiedDateTime": "2023-05-15T14:30:00.1234567Z",
"deletedDateTime": null,
"subject": "Project Update",
"summary": null,
"importance": "high",
"locale": "en-US",
"webUrl": "https://teams.microsoft.com/l/message/19:abcdef0123456789@thread.tacv2/1234567890?groupId=12345678-90ab-cdef-ghij-klmnopqrstuv&tenantId=98765432-10fe-dcba-9876-543210fedcba",
"policyViolation": false,
"from": {
"user": \{
"id": "87654321-fedc-ba98-7654-321fedcba987",
"displayName": "Jane Smith",
"userIdentityType": "aadUser"
\}
},
"body": \{
"contentType": "html",
"content": "<p>Hello team! Here's an update on our project:</p><ul><li>Task A completed</li><li>Task B in progress</li><li>Task C starting next week</li></ul><p>Please review and let me know if you have any questions. @John Doe, can you provide an update on Task B?</p>"
\},
"attachments": [],
"mentions": [
{
"id": 0,
"mentionText": "John Doe",
"mentioned": {
"user": \{
"id": "8765432a-bcde-fghi-jklm-nopqrstuvwxy",
"displayName": "John Doe",
"userIdentityType": "aadUser"
\}
}
}
],
"reactions": [],
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('12345678-90ab-cdef-ghij-klmnopqrstuv')/channels('19:abcdef0123456789@thread.tacv2')/messages/$entity"
}
Create group
Creates an Office 365 group (unified), a dynamic group or security group. Sample Input
\{
"display_name": "Marketing Team",
"mail_nickname": "marketing-team",
"security_enabled": false,
"visibility": "Private",
"group_type": "Unified",
"owners": [
"john.doe@example.com",
"jane.smith@example.com"
],
"members": [
"alice.johnson@example.com",
"bob.wilson@example.com",
"carol.brown@example.com"
]
\}
Sample Output
\{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
"id": "1234abcd-5678-90ef-ghij-klmnopqrstuv",
"createdDateTime": "2023-05-15T10:30:45Z",
"displayName": "Marketing Team",
"description": null,
"groupTypes": [
"Unified"
],
"mail": "marketing-team@example.com",
"mailEnabled": true,
"mailNickname": "marketing-team",
"securityEnabled": false,
"visibility": "Private",
"renewedDateTime": "2023-05-15T10:30:45Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [
"Team"
],
"proxyAddresses": [
"SMTP:marketing-team@example.com"
]
\}
Delete channel
Deletes a channel. Sample Input Sample Output
{
"success": true
}
Delete group
Deletes a specified group. Sample Input Sample Output
{
"success": true
}
Get channel
Returns information about a channel. Sample Input
\{
"group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
"channel_id": "19:a1b2c3d4e5f6g7h8@thread.tacv2"
\}
Sample Output
\{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')/channels/$entity",
"id": "19:a1b2c3d4e5f6g7h8@thread.tacv2",
"displayName": "Marketing Campaign",
"description": "Channel for discussing our upcoming marketing campaign",
"email": "Marketing.Campaign@example.com",
"webUrl": "https://teams.microsoft.com/l/channel/19:a1b2c3d4e5f6g7h8@thread.tacv2/Marketing%20Campaign?groupId=1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p&tenantId=1234abcd-5678-90ef-ghij-klmnopqrstuv"
\}
Get channel tab
Returns information about a specific tab. Sample Input Sample Output
Get group
Returns information about a group. Sample Input Sample Output
\{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
"id": "12345678-90ab-cdef-ghij-klmnopqrstuv",
"deletedDateTime": null,
"classification": "High",
"createdDateTime": "2023-05-15T10:30:00Z",
"creationOptions": [],
"description": "Marketing team for product launches",
"displayName": "Marketing Team",
"expirationDateTime": null,
"externalGroupIds": [],
"externalGroupProviderId": null,
"externalGroupState": null,
"groupTypes": [
"Unified"
],
"isAssignableToRole": null,
"mail": "marketing@contoso.com",
"mailEnabled": true,
"mailNickname": "marketing",
"membershipRule": null,
"membershipRuleProcessingState": null,
"membershipTypes": [],
"onPremisesLastSyncDateTime": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": null,
"preferredLanguage": "en-US",
"proxyAddresses": [
"SMTP:marketing@contoso.com"
],
"renewedDateTime": "2023-05-15T10:30:00Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [],
"securityEnabled": false,
"securityIdentifier": "S-1-12-1-1234567890-123456789-1234567890-1234567",
"theme": null,
"visibility": "Private",
"onPremisesProvisioningErrors": []
\}
Get group notebook
Returns information about a notebook associated with a group. Sample Input
\{
"group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
"notebook_id": "0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p"
\}
Sample Output
{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')/onenote/notebooks/$entity",
"id": "0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
"self": "https://graph.microsoft.com/v1.0/groups/1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p/onenote/notebooks/0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
"createdDateTime": "2023-05-15T10:30:00Z",
"displayName": "Project X Notebook",
"lastModifiedDateTime": "2023-05-20T14:45:00Z",
"isDefault": false,
"userRole": "Owner",
"isShared": true,
"sectionsUrl": "https://graph.microsoft.com/v1.0/groups/1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p/onenote/notebooks/0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p/sections",
"sectionGroupsUrl": "https://graph.microsoft.com/v1.0/groups/1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p/onenote/notebooks/0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p/sectionGroups",
"createdBy": {
"user": \{
"id": "9876543210abcdef",
"displayName": "John Doe"
\}
},
"lastModifiedBy": {
"user": \{
"id": "fedcba0123456789",
"displayName": "Jane Smith"
\}
},
"links": {
"oneNoteClientUrl": {
"href": "onenote:https://contoso.sharepoint.com/sites/ProjectX/SiteAssets/ProjectX%20Notebook"
},
"oneNoteWebUrl": {
"href": "https://contoso.sharepoint.com/sites/ProjectX/_layouts/15/WopiFrame.aspx?sourcedoc={0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p}&action=edit"
}
}
}
Get group OneDrive item
Returns an item from the group's OneDrive. Sample Input Sample Output
{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups('12345678-1234-1234-1234-123456789012')/drive/items/$entity",
"createdDateTime": "2023-05-15T10:30:45Z",
"eTag": "\"aB35dF09cE8\"",
"id": "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD4TL",
"lastModifiedDateTime": "2023-05-16T14:22:18Z",
"name": "Project Proposal.docx",
"webUrl": "https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Project%20Proposal.docx",
"cTag": "\"c:{B4115687-2C5F-4A3F-B4BD-1DC36F23BA3D},1\"",
"size": 25678,
"createdBy": {
"user": \{
"email": "johndoe@contoso.com",
"id": "87654321-4321-4321-4321-210987654321",
"displayName": "John Doe"
\}
},
"lastModifiedBy": {
"user": \{
"email": "janedoe@contoso.com",
"id": "98765432-5432-5432-5432-321098765432",
"displayName": "Jane Doe"
\}
},
"parentReference": \{
"driveId": "b!kIcyViBCLkaTsYJgp0iXsie_qxt-EeRJl-AGHv1mbhJhjeF3zYdEQJgSo1-5tP8I",
"driveType": "documentLibrary",
"id": "01BYE5RZ2FKXMKWDHENFFKH56SGCHTDG3N",
"path": "/drive/root:/Marketing/Projects"
\},
"fileSystemInfo": \{
"createdDateTime": "2023-05-15T10:30:45Z",
"lastModifiedDateTime": "2023-05-16T14:22:18Z"
\},
"folder": {
"childCount": 0
}
}
Get signed in user
Retrieve signed in user's details. Sample Input
{}
Sample Output
Get user
Returns information about a user. Sample Input Sample Output
List channel tabs
Returns a list of tabs in a channel. Sample Input
{
"group_id": "1234567890abcdef",
"channel_id": "19:abcdef1234567890@thread.tacv2",
"select": [
"id",
"displayName",
"webUrl"
],
"filter": [
\{
"field_name": "displayName",
"operator": "eq",
"value": "Important Documents"
\}
],
"condition": "and"
}
Sample Output
List channels
Returns a list of channels for a specific group. Sample Input Sample Output
{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#teams('12345678-1234-1234-1234-123456789012')/channels(id,displayName,description)",
"value": [
\{
"id": "19:abc123def456@thread.tacv2",
"displayName": "General",
"description": "This is the general channel for the team"
\}
]
}
List group members
Returns a list of members for a specific group. Sample Input
\{
"group_id": "12345678-1234-1234-1234-123456789012",
"select": [
"id",
"displayName",
"mail",
"userPrincipalName"
],
"per_page": 10
\}
Sample Output
List group notebooks
Returns a list of notebooks associated with a group. Sample Input Sample Output
List group owners
Returns a list of owners of a specific group. Sample Input
\{
"group_id": "12345678-1234-1234-1234-123456789012",
"select": [
"displayName",
"mail",
"userPrincipalName"
],
"per_page": 10,
"skip_token": "next_page_token_123"
\}
Sample Output
List group plans
Returns a list of plans associated with a group. Sample Input
\{
"group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
"per_page": 50,
"skip_token": "pqrstuvwxyz"
\}
Sample Output
List groups
Returns a list of groups (an AD group, Office 365 group, a team group, a dynamic group or a security group). Sample Input
{
"select": [
"id",
"displayName",
"mail",
"groupTypes"
],
"filter": [
\{
"field_name": "mailEnabled",
"operator": "eq",
"value": true
\}
],
"condition": "and",
"sort_by": "displayName",
"sort_order": "asc",
"per_page": 10
}
Sample Output
List organization users
Returns a list of users in the organizatiobn. Sample Input Sample Output
{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#users(displayName,mail,jobTitle)",
"value": [
\{
"displayName": "Alice Johnson",
"mail": "alice.johnson@example.com",
"jobTitle": "Software Engineer"
\},
\{
"displayName": "Bob Smith",
"mail": "bob.smith@example.com",
"jobTitle": "Software Engineer"
\},
\{
"displayName": "Charlie Brown",
"mail": "charlie.brown@example.com",
"jobTitle": "Software Engineer"
\}
]
}
List team apps
Returns a list of apps installed in the team. Sample Input Sample Output
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('19:1c5b01696d2e4a179c292bc9cf04e047@thread.tacv2')/installedApps(teamsAppDefinition())",
"value": [
{
"id": "NjkwM2ZhOTMtNjA1Yi00M2VmLTkyMWMtNjdjZGM3MDllZDU4IyMwMDAwMTAxNi1kZTA1LTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAjIyMw",
"teamsAppDefinition": \{
"id": "MDEwNzJmOGEtODE5My00ZWY5LTk3NDctY2UwMzJlZjJmNGMw",
"teamsAppId": "com.microsoft.teamspace.tab.planner",
"displayName": "Tasks by Planner and To Do",
"version": "2.0.3"
\}
},
{
"id": "MTk6MWM1YjAxNjk2ZDJlNGExNzljMjkyYmM5Y2YwNGUwNDdAdGhyZWFkLnRhY3YyIyM3MzI0ODIwOS0wOTM5LTQ5MzItOTM2My1jNjAxMzNmYjM4MDc=",
"teamsAppDefinition": \{
"id": "NzMyNDgyMDktMDkzOS00OTMyLTkzNjMtYzYwMTMzZmIzODA3",
"teamsAppId": "com.microsoft.teamspace.tab.wiki",
"displayName": "Wiki",
"version": "1.1.0"
\}
}
]
}
List user teams
Returns a list of teams that a specific user is a member of. Sample Input
{
"user_id": "john.doe@example.com"
}
Sample Output
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams",
"value": [
\{
"id": "19:2a84b1c1-5c8a-43ac-9d68-3d2574a1b6a7@thread.tacv2",
"displayName": "Marketing Team",
"description": "Team for marketing department collaboration",
"isArchived": false
\},
\{
"id": "19:3b7f8d5e-9c2a-4b1d-8f3e-1a5c2d9e8f7a@thread.tacv2",
"displayName": "Project X",
"description": "Team for Project X development",
"isArchived": false
\},
\{
"id": "19:4c9a1f2d-6b3e-5a7c-8d9f-2e1b3c4d5e6f@thread.tacv2",
"displayName": "Company-wide Announcements",
"description": "Official channel for company-wide communications",
"isArchived": true
\}
]
}
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input
{
"method": "POST",
"url": {
"endpoint": "/teams/123456/channels"
},
"headers": [
\{
"key": "Content-Type",
"value": "application/json"
\}
],
"body": {
"raw": \{
"displayName": "Marketing Projects",
"description": "Channel for discussing marketing projects"
\}
},
"include_raw_body": true,
"parse_response": "true"
}
Sample Output
Remove member from group
Removes a member from an Office 365 group (unified), a dynamic group or security group. Sample Input Sample Output
Remove owner from group
Removes an owner from an Office 365 group (unified), a dynamic group or security group. Sample Input
\{
"group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
"owner_id": "9876fedc-ba98-7654-3210-fedcba987654"
\}
Sample Output
{
"success": true
}
Remove tab from channel
Removes a tab from a channel. Sample Input
\{
"group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
"channel_id": "19:a1b2c3d4e5f6g7h8@thread.tacv2",
"tab_id": "01234567-89ab-cdef-0123-456789abcdef"
\}
Sample Output
{
"success": true
}
Search group OneDrive items
Returns a list of items in the group's OneDrive according to search criteria. Sample Input Sample Output
{
"@odata_context": "https://graph.microsoft.com/v1.0/$metadata#drives('12345678-1234-1234-1234-123456789012')/root/search(query='project proposal')",
"value": [
\{
"name": "Project Proposal 2023.docx",
"webUrl": "https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Project%20Proposal%202023.docx",
"size": 2500000,
"lastModifiedDateTime": "2023-05-15T14:30:00Z"
\},
\{
"name": "Project Proposal Presentation.pptx",
"webUrl": "https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Project%20Proposal%20Presentation.pptx",
"size": 3750000,
"lastModifiedDateTime": "2023-05-16T09:45:00Z"
\}
]
}
Unarchive team
Unarchives a team (makes it writable). Sample Input Sample Output
Update adaptive card
Update an adaptive card in a channel. Sample Input Sample Output
Update channel
Updates a channel. Sample Input Sample Output
Update channel tab
Updates a tab inside a channel. Sample Input
{
"group_id": "1234567890abcdef",
"channel_id": "19:abcdef1234567890@thread.tacv2",
"tab_id": "01ABCDEF-2345-6789-0123-456789ABCDEF",
"display_name": "Updated Project Tracker",
"configuration": \{
"entity_id": "projectTracker123",
"content_url": "https://example.com/project-tracker",
"remove_url": "https://example.com/remove-tab",
"website_url": "https://example.com/project-tracker-web"
\}
}
Sample Output
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1234567890abcdef')/channels('19:abcdef1234567890@thread.tacv2')/tabs/$entity",
"id": "01ABCDEF-2345-6789-0123-456789ABCDEF",
"displayName": "Updated Project Tracker",
"webUrl": "https://teams.microsoft.com/l/tab/01ABCDEF-2345-6789-0123-456789ABCDEF?label=Updated%20Project%20Tracker&groupId=1234567890abcdef&tenantId=98765432-1098-7654-3210-987654321098",
"configuration": \{
"entityId": "projectTracker123",
"contentUrl": "https://example.com/project-tracker",
"removeUrl": "https://example.com/remove-tab",
"websiteUrl": "https://example.com/project-tracker-web"
\}
}
Update group
Updates an Office 365 group (unified), a dynamic group or security group. Sample Input
\{
"group_id": "12345678-1234-1234-1234-123456789012",
"description": "Marketing team collaboration group",
"display_name": "Marketing Team",
"mail_nickname": "marketing",
"security_enabled": false,
"visibility": "Private",
"group_type": "Unified",
"allow_external_senders": true,
"auto_subscribe_new_members": true
\}
Sample Output
{
"success": true
}
Update team
Updates a team. Sample Input
{
"team_id": "19:1c5b01696d2e4a179c292bc9cf04e63b@thread.tacv2",
"fun_settings": \{
"allow_giphy": true,
"giphy_content_rating": "moderate",
"allow_stickers_and_memes": true,
"allow_custom_memes": false
\},
"guest_settings": \{
"allow_create_update_channels": false,
"allow_delete_channels": false
\},
"member_settings": \{
"allow_create_update_channels": true,
"allow_delete_channels": false,
"allow_add_remove_apps": true,
"allow_create_update_remove_tabs": true,
"allow_create_update_remove_connectors": false
\},
"messaging_settings": \{
"allow_user_edit_messages": true,
"allow_user_delete_messages": true,
"allow_owner_delete_messages": true,
"allow_team_mentions": true,
"allow_channel_mentions": true
\}
}
Sample Output
{
"success": true
}
DDL operations
List channel tabs (DDL)
Sample Input Sample Output
{
"tabs": [
{
"id": "tab123456",
"displayName": "General",
"webUrl": "https://teams.microsoft.com/l/channel/19%3abc123...tab/General?groupId=teamId123&tenantId=tenantId456",
"configuration": \{
"entityId": null,
"contentUrl": null,
"removeUrl": null,
"websiteUrl": null
\},
"teamsApp": \{
"id": "com.microsoft.teamspace.tab.wiki",
"displayName": "Wiki",
"distributionMethod": "store"
\}
},
{
"id": "tab789012",
"displayName": "Files",
"webUrl": "https://teams.microsoft.com/l/channel/19%3abc123...tab/Files?groupId=teamId123&tenantId=tenantId456",
"configuration": \{
"entityId": null,
"contentUrl": null,
"removeUrl": null,
"websiteUrl": null
\},
"teamsApp": \{
"id": "com.microsoft.teamspace.tab.files.sharepoint",
"displayName": "Files",
"distributionMethod": "store"
\}
}
]
}
List channels (DDL)
Sample Input
{}
Sample Output
List group members (DDL)
Sample Input Sample Output
List group owners (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"owners": [
\{
"id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
"displayName": "John Doe",
"userPrincipalName": "johndoe@example.com",
"mail": "johndoe@example.com",
"jobTitle": "Software Engineer",
"department": "Engineering"
\},
\{
"id": "5f8b1d8e-3c1f-4a7b-9f5d-8e7f6a9b0c1d",
"displayName": "Jane Smith",
"userPrincipalName": "janesmith@example.com",
"mail": "janesmith@example.com",
"jobTitle": "Project Manager",
"department": "Project Management"
\}
]
}
List groups (DDL)
Sample Input
{}
Sample Output
List organization users (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
List user teams (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output