No tracking runs without JavaScript.

Skip to content
Sendtier Docs
Dashboard

Rename the selected organization

Owner only; the path must match the selected tenant, and ownership is checked again inside the request transaction after the organization row is locked. The submitted value has at most 100 characters and no control characters; surrounding whitespace is trimmed and at least one character must remain. Forbidden while the organization is pending deletion; restore it first. The new name appears in the dashboard, invitations and exports.

PATCH/v1/organizations/{tenant_id}

Request body

ParameterDescription
namerequired
string

Maximum length: 100.

Full request schema and constraints

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100

Path parameters

ParameterDescription
tenant_idrequired
string
Full parameter schemas and constraints

Path Parameters

tenant_id*string

Authorization

dashboardToken
cookie__Host-st_session<token>

This scheme applies only to requests from the same-origin dashboard SPA on the dashboard host. The dashboard authenticates with __Host-st_session; st-tenant and st-env select the active organization and mode. The API server at https://api.sendtier.example ignores this cookie; API clients authenticate with bearerAuth.

Response Body

Organization renamed.

application/json
  1. response
id*string
name*string