Delete Tenant by ID

1 min

DELETE

https://api.upstartcommerce.com/v1/tenants/{tenantId}

This endpoint deletes a tenant making all of its associated data inaccessible.

Authorized permissions:

tenant.delete

tenantIdstringUnique identifier for a given tenant.

x-upstart-tenantstringTenant identifier associated with the site this call is for.

200Success-tenant deleted.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

404The requested resource was not found in the NoChannel system.

422The request was well-formed but contains semantic errors or violates business rules that prevent processing.

500An unexpected internal server error occurred. The request may be retried, and if the problem persists, contact support with the traceId from the error response.

curl --request DELETE \
     --url https://api.upstartcommerce.com/v1/tenants/{tenantId} \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'