Update Tenant

1 min

PUT

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

This endpoint updates a tenant.

Authorized permissions:

tenant.update

tenantIdstringUnique identifier for a given tenant.

acceptstringGenerated from available response content types

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

bodyobjectThe tenant fields to update.

200Success-tenant updated successfully.

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.

409The request conflicts with the current state of the resource. This typically occurs when trying to create a resource that already exists or when there's a conflict with business rules.

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.

503A downstream dependency was unavailable, so the request could not be authorized or completed. The request may be retried.

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