Sign in
latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

queueManagerInstances

Transfer a queue manager instance to a different queue

Creates a new QueueManagerInstance in the target queue (identified by template) and marks the source instance as transferred. The new instance inherits patient/appointment/order associations from the source.

The source instance must exist and not already be in a terminal state. The target template must exist and belong to the same account.

If status is omitted, the new instance is placed in the Initial-type status configured on the target template.

post/queueManagerInstances/{id}/transfer

Path parameters

idstring required

ObjectId of the source queue manager instance to transfer

Request body

templatestring required

Target queue template ID (ObjectId of the destination QueueManagerTemplate)

statusstring

Initial status for the new instance in the target queue. Defaults to the target template's Initial-type status if omitted.

Response

The newly created QueueManagerInstance in the target queue

_idstring

ObjectId of the newly created instance

templatestring

ObjectId of the target queue template

source'transfer'
createdFromstring

ObjectId of the original (now soft-deleted) instance

statusstring

Current status in the target queue

deleted0

Always 0 for newly created instances