---
title: "Transfer a queue manager instance to a different queue"
method: POST
path: "/queueManagerInstances/{id}/transfer"
tags: ["queueManagerInstances"]
---

# Transfer a queue manager instance to a different queue

`POST /queueManagerInstances/{id}/transfer`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/queueManagerInstances/{id}/transfer`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/queueManagerInstances/:id/transfer/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `id` string, required

## Request body

- object
  - `template` string, required: Target queue template ID (ObjectId of the destination QueueManagerTemplate)
  - `status` string: Initial status for the new instance in the target queue. Defaults to the target template's Initial-type status if omitted.
  - `customFields` object[]: Custom field values to set on the new instance
    - `name` string: Custom field name
    - `value` unknown
    - `type` string: Custom field type
  - `staffNotes` object: Staff notes to attach to the new instance
    - `value` string, required

## Response `200`

The newly created QueueManagerInstance in the target queue

- object
  - `_id` string: ObjectId of the newly created instance
  - `template` string: ObjectId of the target queue template
  - `source` 'transfer'
  - `createdFrom` string: ObjectId of the original (now soft-deleted) instance
  - `status` string: Current status in the target queue
  - `deleted` 0: Always 0 for newly created instances

## Other responses

- `400`: Validation error. Common causes: - `template` field is missing from the request body. - Request body does not conform to the schema (e.g. unknown properties).
- `401`: Not authenticated
- `403`: Access token does not have the required scope
- `404`: Source instance or target template not found.
- `422`: Status requirements not met on the target template (e.g. the provided `status` value does not exist on the target template, or the target template has no Initial-type status configured).
- `default`: Unexpected error

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)