---
title: "Set an assigned client's document forwarding handle"
method: PUT
path: "/accountant/companies/{customerId}/document-forwarding-address"
tags: ["Accountant Portal"]
---

# Set an assigned client's document forwarding handle

`PUT /accountant/companies/{customerId}/document-forwarding-address`

## Request

- Base URL: `https://api.medianfi.com/api/v1`
- URL: `https://api.medianfi.com/api/v1/accountant/companies/{customerId}/document-forwarding-address`
- Auth: HTTP bearer

## Request body

- object
  - `handle` string, required: 3 to 40 lowercase letters and digits, with single dots or dashes between them. The part before the @.

## Response `200`

The client's forwarding address after the change

- DocumentForwardingAddressResponse
  - `success` true, required
  - `data` object, required
    - `status` 'assigned' | 'name_pending' | 'needs_accountant', required: name_pending while self-serve onboarding has not named the company; needs_accountant when no handle could be generated safely.
    - `handle` string, nullable, required
    - `address` string, email, nullable, required: Null while no mail domain is configured, even when a handle exists.
    - `domain` string, nullable, required

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member
- `404`: Resource not found
- `409`: Another client has or had that address, or one too similar to it. The other client is not named.
- `422`: The handle is malformed or belongs to a Median mailbox

---

[API](https://skmtc.dev/medianfi/apis/median-api.md) · [All operations](https://skmtc.dev/medianfi/apis/median-api/llms.txt) · [OpenAPI document](https://skmtc.dev/medianfi/apis/median-api/revisions/20090ea32b0d?raw)