---
title: "Email a simulation link to open on a computer"
method: POST
path: "/v1/simulation-handoff"
tags: ["Simulation"]
---

# Email a simulation link to open on a computer

`POST /v1/simulation-handoff`

## Request

- Base URL: `https://api.uxduck.com`
- URL: `https://api.uxduck.com/v1/simulation-handoff`
- Auth: none declared

## Request body

- object
  - `email` string, email, required
  - `updates` boolean, required
  - `handoffId` string, uuid, required
  - `start` object, required
    - `vehicle` union, required
      - 'plane'
      - 'multicopter'
      - 'vtol'
      - 'rover'
      - 'boat'
      - 'submarine'
      - 'airship'
      - 'jet'
    - `latitudeDeg` number, required
    - `longitudeDeg` number, required
    - `headingDeg` number, required
    - `inAirM` number

## Response `202`

Email sent; updates require their own confirmation

- object
  - `status` 'sent', required
  - `updates` 'requested' | 'not-requested' | 'unavailable', required

## Other responses

- `400`: Invalid email or starting choices
- `403`: Verification failed
- `429`: Too many email requests
- `503`: Email or verification unavailable

---

[API](https://skmtc.dev/uxduck/apis/uxduck-api.md) - [All operations](https://skmtc.dev/uxduck/apis/uxduck-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uxduck/apis/uxduck-api/revisions/d594d81b2806?raw)