Create Tenant

1 min

POST

https://api.upstartcommerce.com/v1/tenants/create

This endpoint creates a new tenant asynchronously. The tenant will be created and a verification email sent to the provided email address.

This endpoint is unauthenticated. It is the entry point to self-service tenant signup, so the caller has neither a tenant nor credentials yet. The tenant is not usable until the emailed verification code is presented to verifyTenantRequest.

bodyobjectThe tenant to create, with its name, domain and contact details.

202Success-tenant creation initiated. Verification email sent to the provided address.

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.

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 POST \
     --url https://api.upstartcommerce.com/v1/tenants/create \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "name": "Acme Retail Corporation",
     "email": "[email protected]",
     "sites": [
     {
     "enabled": true,
     "name": "US West Coast Store",
     "url": "westcoast.acmeretail.com"
     }
     ]
     }'