---
title: "Hide Payees from Group"
method: POST
path: "/entityGroup/{entityGroupId}/hidePayees"
tags: ["entity-group > counterparty"]
---

# Hide Payees from Group

`POST /entityGroup/{entityGroupId}/hidePayees`

## Request

- Base URL: `https://api.mercoa.com`
- URL: `https://api.mercoa.com/entityGroup/{entityGroupId}/hidePayees`
- Auth: HTTP bearer

Marks Payees as unsearchable by all entities in the group via Counterparty search. Invoices associated with these Payees will still be searchable via Invoice search.

## Path parameters

- `entityGroupId` string, required

## Request body

- EntityTypesEntityHidePayeesRequest
  - `payees` EntityTypesEntityId[], required: List of payee entity IDs or foreign IDs to hide

## Response `200`

Successful response

## Other responses

- `400`: Error response with status 400
- `401`: Error response with status 401
- `403`: Error response with status 403
- `404`: Error response with status 404
- `409`: Error response with status 409
- `500`: Error response with status 500
- `501`: Error response with status 501

---

[API](https://skmtc.dev/mercoa/apis/mercoa-2.md) - [All operations](https://skmtc.dev/mercoa/apis/mercoa-2/llms.txt) - [OpenAPI document](https://skmtc.dev/mercoa/apis/mercoa-2/revisions/00a8e403ae18?raw)