---
title: "Create access group"
method: POST
path: "/access-groups"
tags: ["Access Group"]
---

# Create access group

`POST /access-groups`

The ability to create a new access group

## Request body

- AccountAccessGroupRequest
  - `action` 'ADD' | 'REMOVE' — Action to apply for the supplied account bid
  - `accountIds` string[] — Bids of the accounts to be added/removed
  - `beneficiaryIds` string[] — Bids of the beneficiaries to be added/removed
  - `name` string — The name of the account group to create. Must match: [\w \-]*

## Response `201`

Created

- AccountAccessGroupResponse — AccessGroup
  - `id` string — Unique ID for the access group
  - `name` string — Access group name
  - `type` 'SERVICE_PARTNER' | 'SERVICE_CUSTOMER' | 'DELEGATE' | 'USER_DEFINED' — The type of access group
  - `typeId` string — The identifier of the linked entity implied by the type, e.g. the partner ID
  - `status` 'ACTIVE' | 'DELETED' — Status of the access group
  - `countOfAccounts` integer — The number of accounts in this group

## Other responses

- `400` — Validation errors

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/revisions/cbd52524c8ef/schema)