Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Logo
Sign inBook a demo
API ReferenceEntity GroupCounterparty

Hide Payors from Group

POST
https://api.mercoa.com/entityGroup/:entityGroupId/hidePayors
POST
/entityGroup/:entityGroupId/hidePayors
1curl -X POST https://api.mercoa.com/entityGroup/entg_8545a84e-a45f-41bf-bdf1-33b42a55812c/hidePayors \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "payors": [
6 "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
7 ]
8}'
Try it
Marks Payors as unsearchable by all entities in the group via Counterparty search. Invoices associated with these Payors will still be searchable via Invoice search.
Was this page helpful?
Previous

Search Group Users

Next
Built with
Search Group Users
Marks Payors as unsearchable by all entities in the group via Counterparty search. Invoices associated with these Payors will still be searchable via Invoice search.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

entityGroupIdstringRequired
Entity Group ID or Entity Group ForeignID

Request

This endpoint expects an object.
payorslist of stringsRequired
List of payor entity IDs or foreign IDs to hide

Errors

Entity Group ID or Entity Group ForeignID

Bearer authentication of the form Bearer <token>, where token is your auth token.