POST
/api/integrations/msp/tenants/{id}/inviteInvite an existing account as an MSP tenant
Submits an invitation to an existing tenant account to join the MSP account. Use the id path parameter to identify the tenant account being invited; the account must already exist. A 200 response returns the updated tenant account, including its invitation status and DNS challenge.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
idstringrequired
The unique identifier of the existing tenant account to invite to the MSP account.
200Returns the updated MSP tenant account, including its ID, name, domain, groups, status, invitation and activation timestamps, 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
updated_atstringrequired
The date and time when the tenant was last updated.
400Returned when the request is invalid.
403Returned when authentication is required.
404Returned when the tenant account is not found.
500Returned when an internal server error occurs.
Error handling
A 400 indicates the request is invalid. A 403 indicates authentication is required, and a 404 is returned when the tenant identified by the id path parameter is not found. A 500 indicates an internal server error.