For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
      • GETGet All Groups
      • POSTCreate Group
      • GETGet Group
      • POSTUpdate Group
      • DELDelete Group
      • POSTGenerate JWT Token
      • POSTAdd Entities
      • POSTRemove Entities
        • GETSearch Group Users
        • POSTCreate Group User
        • GETGet Group User
        • POSTUpdate Group User
        • DELDelete Group User
        • POSTGenerate JWT Token
        • POSTSync Group Users
Logo
Sign inBook a demo
API ReferenceEntity GroupUser

Create Group User

POST
https://api.mercoa.com/entityGroup/:entityGroupId/user
POST
/entityGroup/:entityGroupId/user
$curl -X POST https://api.mercoa.com/entityGroup/entg_8545a84e-a45f-41bf-bdf1-33b42a55812c/user \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "foreignId": "MY-DB-ID-12345",
>  "email": "john.doe@acme.com",
>  "name": "John Doe",
>  "entities": [
>    {
>      "roles": [
>        "admin",
>        "approver"
>      ],
>      "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
>    },
>    {
>      "roles": [
>        "viewer"
>      ],
>      "entityId": "ent_9e02a20e-7749-47de-8d8a-f8ff2859fa90"
>    }
>  ]
>}'
1{
2  "foreignId": "MY-DB-ID-12345",
3  "entities": [
4    {
5      "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
6      "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
7      "roles": [
8        "admin",
9        "approver"
10      ]
11    },
12    {
13      "entityId": "ent_9e02a20e-7749-47de-8d8a-f8ff2859fa90",
14      "id": "user_3a3aafc8-ea86-408a-a6c1-545497badbbb",
15      "roles": [
16        "viewer"
17      ]
18    }
19  ],
20  "createdAt": "2024-01-01T00:00:00Z",
21  "updatedAt": "2024-01-01T00:00:00Z",
22  "email": "john.doe@acme.com",
23  "name": "John Doe"
24}
Create entity user that will be added to all entities in the group. If a user with the same foreignId already exists, the user will be updated with the new information.
Was this page helpful?
Previous

Get Group User

Next
Built with

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.
foreignIdstringRequired
The ID used to identify this user in your system. This is a required field and needs to be unique for all users in the group.
emailstringOptional
namestringOptional
roleslist of stringsOptional

List of roles to assign to the user. A role can be any string. For example: “payer”, “approver”, “viewer” If not provided, the user will have no roles. Per entity roles will override these global roles.

entitieslist of objectsOptional
List of roles per entity. Useful for assigning roles to specific entities.

Response

This endpoint returns an object.
foreignIdstring
The ID used to identify this user in your system.
entitieslist of objects
List of roles per entity.
createdAtdatetime
updatedAtdatetime
emailstring
namestring

Errors

400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
409
Conflict
500
Internal Server Error
501
Unimplemented