Start free trial

Update entity group

PATCH/api/v1/advisory-firms/{firm_id}/entity-groups/{group_id}

Update a group's name, description, type, or primary entity.

Operation ID: update_entity_group_api_v1_advisory_firms__firm_id__entity_groups__group_id__patch·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_idstringrequired
group_idstringrequired

Request body

Schema: UpdateEntityGroupRequest

namestring
descriptionstring
group_typestring
primary_business_idstring

Responses

200Successful Response

Schema: SuccessEnvelope_EntityGroupResponse_

successboolean
messagestring
codestring
dataEntityGroupResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

409Conflict - Resource already exists

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject