VEvetnio
consultations

Rename a consultation

Changes the display name of a consultation. Only name can be changed through this endpoint. Any member of the workspace can rename any consultation in it. Returns 403 for archived consultations and 404 if the consultation does not exist in this workspace.

patch/workspaces/{workspaceId}/consultations/{consultationId}

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Identifier of the consultation (UUID), as returned when it was created or by GET /workspaces/{workspaceId}/consultations. It must belong to the clinic in workspaceId.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

namestring required

New display name. Replaces the current name; free text with no length limit (an empty string is accepted).

Example request

{
  "name": "Bella - vaccination and dental check"
}

Response

Consultation renamed.

object required

Empty object returned on success.

Changes

No recorded changes to this operation across all 1 revision of this API.