Sign in

v1

latestOpenAPI 3.0.32026-07-24411867.5 KB

Assign or update a firm role on an entity

⚠️ DEPRECATED: This endpoint is deprecated and will be removed in a future version. Please use the new endpoints /entities/{entity_id}/firm_role_assignments instead.

Assigns a firm role to a firm user for the given entity. You may identify the entity by entity_id or external_entity_id, and the firm user by firm_user_id or firm_user_email. If replace_existing_firm_role is true, existing assignments for that user+firm on the entity are removed before adding the new one.

post/entities/update_firm_role

Request body

entity_idinteger
external_entity_idstring
firm_role_namestring required
firm_user_idinteger nullable
firm_user_emailstring email nullable
replace_existing_firm_roleboolean

Response

Updated entity with role assignment applied

idinteger required
entity_typestring required
namestring required
streetstring nullable
statestring nullable
citystring nullable
zipstring nullable
countrystring nullable
tax_return_namestring required
created_atstring date-time required
upload_linkstring uri required
business_emailstring nullable
other_emailstring nullable
external_entity_idstring nullable
deleted_atstring date-time nullable
hash_idstring required