Update Engagement Account Group - MindBridge Documentation

curl --request PUT \ --url https://{tenant}.mindbridge.ai/api/v1/engagement-account-groups/{engagementAccountGroupId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "code": "<string>", "hidden": true, "macCode": "<string>", "alias": "<string>" } '

{ "id": "<string>", "engagementAccountGroupingId": "<string>", "code": "<string>", "description": {}, "lowestLevel": true, "hierarchy": [ "<string>" ], "parentCode": "<string>", "macCode": "<string>", "accountTags": [ "<string>" ], "publishedDate": "2023-11-07T05:31:56Z", "orderIndex": 123, "errors": [ { "arguments": [ "<string>" ] } ], "hidden": true, "alias": "<string>" }

Authorizations

Authorization

string

header

required

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

Path Parameters

engagementAccountGroupId

string

required

Body

application/json

code

string

required

The account code for this account group.

Minimum string length: 1

hidden

boolean

required

When true this account is hidden, and can't be used in account mapping. Additionally this account won't be suggested when automatically mapping accounts during file import.

macCode

string

The MAC code mapped to this account group.

alias

string

A replacement value used when displaying the account description.

This does not have any effect on automatic column mapping.

Response

200 - application/json

string

The unique object identifier.

engagementAccountGroupingId

string

The unique identifier for the engagement account grouping that the engagement account group belongs to.

code

string

The account code for this account group.

description

object

A description of the account code for this account group.

Show child attributes

lowestLevel

boolean

hierarchy

string[]

A list of the parent codes for this account group.

parentCode

string

The parent code for this account group.

macCode

string

The MAC code mapped to this account group.

accountTags

string[]

A list of account tags assigned to this account group.

publishedDate

string<date-time>

The date this account group was published. If not set, this account group is not published.

Published account groups cannot be updated.

orderIndex

integer<int32>

The order in which this account group is displayed, relative to other account groups with the same parent.

errors

Account Group Error · object[]

A list of errors associated with this account group.

Show child attributes

hidden

boolean

When true this account is hidden, and can't be used in account mapping. Additionally this account won't be suggested when automatically mapping accounts during file import.

origin

enum<string>

The process that lead to the creation of the account group.

Available options:

IMPORTED_FROM_LIBRARY,

IMPORTED_FROM_ENGAGEMENT,

ADDED_ON_ENGAGEMENT

alias

string

A replacement value used when displaying the account description.

This does not have any effect on automatic column mapping.