light-mode-image
Learn
API ReferenceTenants

Delete tenant

Analytics Events

TENANT_DELETE_STARTTENANT_DELETE_SUCCESSTENANT_DELETE_FAIL
DELETE/v1/tenants/{tenantId}

Deletes a tenant by its ID.

Analytic events

  • TENANT_DELETE_START
  • TENANT_DELETE_SUCCESS
  • TENANT_DELETE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Unique ID of the tenant to delete.

Formatuuid

Response Body

application/json

text/plain

application/json

curl -X DELETE "https://manage.mattr.global/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
"Unauthorized"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
Empty

How would you rate this page?

Retrieve tenant GET

Retrieves a tenant by its ID. ### **Analytic events** * TENANT_RETRIEVE_START * TENANT_RETRIEVE_SUCCESS * TENANT_RETRIEVE_FAIL

Invite a tenant member POST

Invites a user to join the tenant and assigns roles to them within the tenant's context. If the user has not registered to the Self Service Portal yet, then they will receive an email with a link to accept the invite. If the user has already registered, then they will be added as a member to the tenant immediately. ### **Analytic events** * TENANT_MEMBER_INVITATION_CREATE_START * TENANT_MEMBER_INVITATION_CREATE_SUCCESS * TENANT_MEMBER_INVITATION_CREATE_FAIL