---
title: "Return a checked-out account"
method: POST
path: "/v1/addresses/{address}/return"
---

# Return a checked-out account

`POST /v1/addresses/{address}/return`

## Request

- Base URL: `https://api.proxymail.qa`
- URL: `https://api.proxymail.qa/v1/addresses/{address}/return`
- Auth: HTTP bearer

Frees it for the next test, and can record the state you left it in: tags to add (premium) and to remove (trial).

## Path parameters

- `address` string, email, required

## Request body

- object
  - `token` string, uuid, required
  - `add_tags` string[]
  - `remove_tags` string[]

## Response `200`

The account

- Address
  - `address` string
  - `label` string, nullable
  - `created_at` string, date-time
  - `expires_at` string, date-time
  - `persona` object, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `username` string, nullable
    - `date_of_birth` string, date: Present only when the address has one.
    - `country` string: ISO 3166-1 alpha-2 code, such as GB. Present only when the address has one.
  - `notes` string, nullable
  - `tags` string[]
  - `has_password` boolean
  - `password` string: Only in the response to creating it with password: true.
  - `site` string: Where it is used: the host of the app under test. Present only when set.
  - `environment` string: Which environment it is used in, such as staging. Present only when set.
  - `email_count` integer
  - `latest` object, nullable: The newest code or link, like Match.
  - `checked_out_until` string, date-time: Only while someone has it checked out of the pool.

## Other responses

- `400`: An error
- `404`: An error
- `409`: An error

---

[API](https://skmtc.dev/proxymail/apis/proxy-mail-qa-api.md) · [All operations](https://skmtc.dev/proxymail/apis/proxy-mail-qa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/proxymail/apis/proxy-mail-qa-api/revisions/8f8a5e84cf5c?raw)