Skip to main content

Fully replace an existing specialty record

PUT 
/specialties/:id

Performs a full replacement of the specialty record with the given ID. All fields of the specialty are overwritten with the values supplied in the request body; omitted optional fields revert to their default or null values.

When to use: Use this endpoint when you need to update one or more fields of an existing specialty. Because this is a full-replace operation (not a partial update), you must supply the complete desired state of the resource in the request body.

Preconditions: Requires the UPDATE_SPECIALTY permission. The tenant-id header must be supplied. The request body data object is validated against the Specialty JSON Schema before the update is applied; a validation failure returns 400.

Result: Returns 200 with the updated specialty object reflecting the new state. A nonexistent id and a JSON Schema validation failure both currently surface as 400 Bad Request with the same generic error shape — the response body does not distinguish between the two causes. Idempotent with respect to the same complete payload — repeating the call with identical data leaves the resource unchanged.

Request​

Responses​

The specialty was fully replaced; the response body is the updated record.