GuidesRecipesAPI Reference
Log In
Guides

Upsert multiple investors

Value
DescriptionInsert or update multiple investor’s data. When creating a new investor, the request body should not contain “id” or “internalId” as this will be auto generated.
Path/api/entities/investor/multiple/upsert/{scopeId}
MethodPOST
Request Parameters
  • *scopeId:** A scope ID in which you want to insert or update investor list.
Request BodyArray of investor object. There are 3 required fields.
  • name (text)
  • typeId (number)
  • type (text)
List of typeId and corresponding type fields:
TypeId = Type
1 -> General Partner
2 -> Limited Partner
3 -> Special Limited Partner
4 -> Third Party
Responses
  • *200 (OK):** N/A
  • *400 (Bad Request):** Request body is either in incorrect format or empty.
Remarks
  • *Warning:** This API has no validation. All data should be carefully reviewed before submitting.
  • *Remark:** To set value for these 3 standard fields: placeOfIncorporation, entityStatus and entityOwners, you should also set values to their corresponding Id fields.
ReferenceLink

Request body example