patchCaptableStakeholdersByIdWithHttpInfo method

Future<Response> patchCaptableStakeholdersByIdWithHttpInfo(String id, CaptableStakeholderPatch captableStakeholderPatch)

Changes one of the caller org's stakeholders.

Changes one of the caller org's stakeholders. It is a PARTIAL update: only the fields the request names are written, and a field sent as null clears that column. A request that names no updatable field is refused, and an id this org does not hold is not found. The values are stored as sent. Unlike adding a stakeholder, this route does not check the email's shape or the type and relationship vocabularies, so it can record a value that adding one would have rejected.

Note: This method returns the HTTP Response.

Parameters:

• String id (required): ID is the stakeholder to update. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id from another tenant is simply not found.

• CaptableStakeholderPatch captableStakeholderPatch (required):

Implementation

Future<Response> patchCaptableStakeholdersByIdWithHttpInfo(String id, CaptableStakeholderPatch captableStakeholderPatch,) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/captable/stakeholders/{id}'
    .replaceAll('{id}', id);

  // ignore: prefer_final_locals
  Object? postBody = captableStakeholderPatch;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>['application/json'];


  return apiClient.invokeAPI(
    path,
    'PATCH',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}