API Reference

Update a Household

put
https://api.bridgeft.com/v2/reporting/households/

Provide a Household to update. Then entire Household object must be provided to the PUT request.

Editable Fields:

  • name
  • benchmarks_ids
Path Params
integer
required

Unique ID for the object

Body Params
int64

Unique household identifier

string

Populated from custodian data but can be modified by users

integer

ID of the owning firm

string

See Entiti ID Prefixes

date-time

Date the household was opened

date-time

Date of household inception, if applicable. May differ from opening date

date-time

Date the household was closed, if applicable

string
deprecated

See Account and Household Status Codes.

benchmarks_ids
array of integers

List of ids for benchmarks associated with the household

Benchmarks id list
boolean

Is this entity an account? (No)

boolean

Is this entity a household? (Yes)

date-time

Most recent date that portfolio data was processed for this household

date-time

Earliest date that portfolio data was processed among accounts in this household

date-time

Most recent date that portfolio data was processed among accounts in this household

string
deprecated

Short name for the household object

date-time

Timestamp for when the record was created

date-time

Timestamp for when the record was updated

Responses

Updated 7 months ago

Language
Credentials
Bearer
Bearer
Response 
 Choose an example:
application/json
Updated 7 months ago