latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Tenant Specialty

Replace a tenant specialty's data in full

Replaces the stored data for an existing tenant specialty. This is a full-replacement operation — fields not included in the request body are cleared, not preserved.

What it does: Overwrites the tenant specialty identified by {id} with the supplied payload. The data layer performs a replace, not a merge, so callers must supply all fields they wish to retain.

When to use: Use this to update any attribute of a tenant specialty after it has been created.

How to call it: Supply the required tenant-id header and the tenant specialty id as a path segment (an opaque, server-assigned string). The request body is validated against the TenantSpecialty JSON Schema on the data field; validation failures return 400. The same request schema is used as for POST. Requires the UPDATE_TENANT_SPECIALTY permission. Returns 404 if no specialty with the given id exists for the supplied tenant-id — the record is looked up before any write is attempted.

What you get back: On success (200) the full updated tenant specialty object is returned. This operation is idempotent — sending the same payload twice produces the same state.

put/tenant-specialties/{id}

Path parameters

idstring required

Opaque, server-assigned identifier of the tenant specialty to replace.

Headers

tenant-idstring required

Tenant identifier that scopes the update.

Request body

specialtyIdstring required

Identifier of the global specialty this tenant specialty is based on. Required and must reference an existing global specialty; a missing or blank value is rejected with 400 before any other validation runs.

Response

The full tenant specialty object after replacement.

idstring
tenantIdstring
specialtyIdstring