Skip to main content
PUT
/
v1
/
team
Create a new team
curl --request PUT \
  --url https://api.wirespeed.co/v1/team \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domain": "<string>",
  "ownerFirstName": "<string>",
  "ownerLastName": "<string>",
  "ownerEmail": "<string>",
  "platformName": "<string>",
  "faviconUrl": "<string>",
  "demo": false,
  "refreshable": true,
  "autoSubscribeServiceProviderUsers": true,
  "addOns": [
    "data"
  ],
  "skuStartDate": "<string>",
  "skuEndDate": "<string>",
  "isTrial": false
}
'
{
  "data": [
    {
      "id": "<string>",
      "intercomId": "<string>",
      "createdAt": "<string>",
      "displayName": "<string>",
      "email": "<string>",
      "locked": true,
      "isServiceAccount": true,
      "activeTeamId": "<string>",
      "parentTeamId": "<string>",
      "completedOnboarding": true,
      "teamId": "<string>",
      "autoSubscribeToNotifications": true,
      "isExternal": true,
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the team (1-512 characters)

​
domain
string
required

Domain URL for the team

​
ownerFirstName
string

First name of the team owner (1-512 characters)

​
ownerLastName
string

Last name of the team owner (1-512 characters)

​
ownerEmail
string

Email address of the team owner

​
platformName
string

Platform name of the team

​
faviconUrl
string

Favicon URL for the team

​
demo
boolean
default:false

Whether this is a demo team

​
refreshable
boolean
default:true

Whether this demo team should be automatically deleted and recreated weekly

​
autoSubscribeServiceProviderUsers
boolean
default:true

Whether to auto-subscribe the service provider users to the new team

​
sku
enum<string>

Subscription SKU tier for the team

Available options:
identity,
adr
​
addOns
enum<string>[]

Add-on SKUs for the team

Available options:
data
​
skuStartDate
string

Contract/subscription start date (ISO string)

​
skuEndDate
string

Contract/subscription end date (ISO string)

​
isTrial
boolean
default:false

Whether this team is a proof-of-value trial

​
address
object

Address of the organization

Response

​
data
object[]
required

Array of team member user objects