---
title: "Change its label, notes, tags or persona"
method: PATCH
path: "/v1/addresses/{address}"
---

# Change its label, notes, tags or persona

`PATCH /v1/addresses/{address}`

## Request

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

Send only the fields to change; null or an empty string clears one. Use it when the app under test changed the first name, last name or username, so the saved persona still matches. To change the password, use PUT /v1/addresses/{address}/password.

## Path parameters

- `address` string, email, required

## Request body

- object
  - `label` string, nullable
  - `notes` string, nullable
  - `tags` string[]
  - `first_name` string, nullable
  - `last_name` string, nullable
  - `username` string, nullable
  - `date_of_birth` string, date, nullable: YYYY-MM-DD; null clears it.
  - `country` string, nullable: ISO 3166-1 alpha-2 code such as GB; null clears it.

## Response `200`

The address

- 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

---

[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)