Skip to main content
PUT
Create a new team

Authorizations

Authorization
string
header
required

Team API key sent as a Bearer token. Create a key in Wirespeed under Settings → Team. See https://docs.wirespeed.co/api-reference/authentication.

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
premiumRetentionType
enum<string>

Retention for premium integration data (integrations unlocked by the Data add-on). Requires the DATA add-on; defaults to NINETY_DAYS when the add-on is present and this is omitted.

Available options:
NINETY_DAYS,
ONE_YEAR
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

language
enum<string> | null

Default language for team members without their own choice, and for messages to people outside Wirespeed. Omit or send null for no default (English).

Available options:
en,
fr,
de
region
enum<string> | null

Default formatting region (ISO 3166-1 alpha-2) for team members without their own choice. Omit or send null to use the language's default region.

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW

Response

data
object[]
required

Array of team member user objects