entity-group > user

Update Group User

Update entity user for all entities in the group.

post/entityGroup/{entityGroupId}/user/{foreignId}

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entityGroup/{entityGroupId}/user/{foreignId}
  • Auth: HTTP bearer

Path parameters

entityGroupIdstring required

Entity Group ID or Entity Group ForeignID

foreignIdstring required

ID used to identify user in your system

Request body

foreignIdstring required

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.

emailstring
namestring
rolesstring[]

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.

Response

Response with status 200

foreignIdstring required

The ID used to identify this user in your system.

emailstring
namestring
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.