Returns the updated VisitV1.

Request

Updates the visit identified by the path parameter. Validation errors return 400; 404 (VisitV1 not found) when the resource is missing.

Response shapes: A normal update returns the full visit in data. Delete via procedures: [] returns { id } only (see DeletedResult).

txCase is read-only after create. It may be sent and is validated, but changes are ignored.

Completed tx case: Any field change except procedures is rejected. You cannot add or replace procedures; you may only remove procedures (including [] to delete the visit).

Security

bearerAuth or oAuthSandbox

Path

visitIdinteger, (int64), >= 1required

ID of the visit to update

Example:1

Query

responseFieldsstring

A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names.

Organization-IDstringrequired

Organization context for the request. Must match the organization authorized by the access token.

Example:1006

Bodyapplication/jsonrequired

Purpose: Update visit sequencing, duration, or assigned procedures.

Delete via update: Send procedures: [] to delete the visit. Procedures are unassigned back to the treatment planner; sibling sequences are reordered; an empty case may be deleted.

Completed tx case: Only procedures may be sent, and only as a subset of the current IDs (or []). Changing duration, sequence, or order fields, or adding/swapping procedure IDs, is rejected.

Omitted fields: Unchanged. Create-time defaults (duration 60, visitProceduresOrderType TEETH) are not applied on PUT. Do not send those values unless you intend to change the field.

Idempotency: Not supported.

durationinteger, (int32), [ 10 .. 240 ]

Visit length in minutes. Allowed range is 10–240. Omitted on PUT leaves the existing value unchanged.

Example:90

sequenceinteger, (int32)

Example:0

visitProceduresOrderTypestring

Procedure sort order. Omitted on PUT leaves the existing value unchanged.

Enum:"TEETH""CREATED""CODE""SURFACES""DESCRIPTION""PROVIDER""AMOUNT""CUSTOM"

Example:"CODE"

descProceduresOrderboolean

When true, sort procedures descending. Omitted on PUT leaves the existing value unchanged.

Example:true

proceduresArray of objects

curl -i -X PUT \
  'https://papidocs.hs1api.com/_mock/publicapi/api-miscellaneous/v1/visits/1?responseFields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Organization-ID: 1006' \
  -d '{
    "duration": 90,
    "sequence": 0
  }'

Responses

Visit was updated (full resource) or deleted via procedures: [] (data is { id } only)

Bodyapplication/json

One of:

dataobject(VisitV1)

This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide

Example:

{
  "descProceduresOrder": true,
  "procedures": [
    { … }
  ],
  "txCase": {
    "id": 12345,
    "url": "https://api.example.com/models/12345",
    "type": "ExampleModelType"
  },
  "id": 12445,
  "type": "VisitV1"
}

warningsArray of objects(Error)

Example:

[
  {
    "code": "VALIDATION_ERROR",
    "title": "Validation Failed",
    "description": "The provided data does not meet the required validation rules.",
    "source": "request.body"
  }
]

errorsArray of objects(Error)

Example:

[
  {
    "code": "ERR101",
    "title": "Example Title"
  }
]

Response

{
  "data": {
    "id": "9000000038237",
    "type": "VisitV1",
    "lastModified": "2024-01-12T15:58:19.443Z",
    "sequence": 0,
    "duration": 60,
    "visitProceduresOrderType": "TEETH",
    "descProceduresOrder": false,
    "txCase": { … },
    "procedures": [ … ]
  },
  "warnings": [
    { … }
  ]
}