Create a workspace

POST https://sml-api.io/teams

Creates a workspace from a template. Seamless sets up the Microsoft 365 group, the team and the SharePoint site exactly as for a request in the app: with the channels, libraries, permissions and rules of the template.

Naming convention

Via the API, Seamless does not apply the template’s naming convention. Pass displayName and mailNickName exactly as the workspace should be named. You get the template’s rules with Get an organisation.

Parameters

Field	Type	Description
displayName	Text	Display name of the workspace
description	Text, optional	Description
mailNickName	Text	Unique part of the email address before the @
responsible	Text	Primary contact, as email address or user ID
deputy	Text, optional	Deputy, as email address or user ID
organisationIdOrIdentifier	Text	ID or identifier of the organisation
templateIdOrIdentifier	Text	ID or identifier of the template. The template must be enabled for the API under Availability (App & API or API).
owners	List	Owners, as email addresses or user IDs
members	List	Members, as email addresses or user IDs

Request

cURL

curl -X POST https://sml-api.io/teams \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "260215.001 - Project Atlas",
    "description": "New office building Atlas",
    "mailNickName": "prj-260215.001",
    "responsible": "anna.muster@contoso.com",
    "deputy": "marco.rossi@contoso.com",
    "organisationIdOrIdentifier": "contoso",
    "templateIdOrIdentifier": "prj",
    "owners": ["anna.muster@contoso.com", "marco.rossi@contoso.com"],
    "members": ["lea.meier@contoso.com", "jonas.keller@contoso.com"]
  }'

PowerShell

$body = @{
  displayName                = '260215.001 - Project Atlas'
  description                = 'New office building Atlas'
  mailNickName               = 'prj-260215.001'
  responsible                = 'anna.muster@contoso.com'
  deputy                     = 'marco.rossi@contoso.com'
  organisationIdOrIdentifier = 'contoso'
  templateIdOrIdentifier     = 'prj'
  owners                     = @('anna.muster@contoso.com', 'marco.rossi@contoso.com')
  members                    = @('lea.meier@contoso.com', 'jonas.keller@contoso.com')
} | ConvertTo-Json

Invoke-RestMethod -Method Post -Uri 'https://sml-api.io/teams' -Headers $headers `
  -ContentType 'application/json; charset=utf-8' -Body $body

C#

var res = await http.PostAsJsonAsync("/teams", new {
    displayName = "260215.001 - Project Atlas",
    description = "New office building Atlas",
    mailNickName = "prj-260215.001",
    responsible = "anna.muster@contoso.com",
    deputy = "marco.rossi@contoso.com",
    organisationIdOrIdentifier = "contoso",
    templateIdOrIdentifier = "prj",
    owners = new[] { "anna.muster@contoso.com", "marco.rossi@contoso.com" },
    members = new[] { "lea.meier@contoso.com", "jonas.keller@contoso.com" }
});

Response

{
  "status": "…",
  "teamId": "…",
  "statusUrl": "…"
}

Field	Description
status	Creation status
teamId	ID of the new workspace
statusUrl	Address where you query the creation status

Note

Creation runs in the background and takes one to several minutes depending on the template. You also see the status in the Admin Center under Monitoring → Provisioning.

Next steps

Rename a workspacePATCH /teams/{teamId}/name

Learn more

List organisationsGET /organisationsGet an organisationGET /organisations/{idOrIdentifier}Naming conventionsEnforce consistent names for workspacesSet up templatesAvailability and identifierRequest a workspaceWizard in the Seamless AppPrimary contactOne primary contact per workspaceProvisioningTrack provisioning