NetBird Full API Reference + Read-Only MCP Prototype
PUT/api/integrations/msp/tenants/{id}

Replace an MSP tenant's details

Replaces an MSP tenant's name and group access configuration. Supply the required name and groups, including an id and role for each group entry. The response contains the updated tenant details.

1 parameter · 2 body fields
idstringrequired
The unique identifier of the tenant account to update.

Replacement tenant name and group access configuration.

groupsarray<object>required
MSP users Groups that can access the Tenant and Roles to assume
namestringrequired
The name for the MSP tenant

4 status codes
200Returns the updated MSP tenant object, including its identifier, name, domain, groups, status, and DNS challenge.
activated_atstringoptional
The date and time when the tenant was activated.
created_atstringrequired
The date and time when the tenant was created.
dns_challengestringrequired
The DNS challenge to set in a TXT record
domainstringrequired
The tenant account domain
groupsarray<object>required
MSP users Groups that can access the Tenant and Roles to assume
idstringrequired
The updated MSP tenant account ID
invited_atstringoptional
The date and time when the existing tenant was invited.
namestringrequired
The name for the MSP tenant
statusstringrequired
The status of the tenant
Allowed:existinginvitedpendingactive
updated_atstringrequired
The date and time when the tenant was last updated.
400Returned when required fields are missing or the request fails validation.
403Returned when the request is missing valid authentication.
500Returned when an internal server error occurs.

Error handling

The id path parameter identifies the tenant to update. The body must include name and groups, and each group entry must include id and role; a 400 is returned when validation fails. A 403 is returned when authentication is missing or invalid, and a 500 indicates an internal server error.