API · Manage · Portfolios
Update the portfolio.
Update a portfolio's mutable fields: name, shared_registered_agent_id (pass null to clear), shared_compliance_calendar, and metadata (whole-map replacement — send the full desired map, there is no per-key merge). At least one of the four must be present. Membership is managed through `POST /portfolios/{id}/entities` and `DELETE /portfolios/{id}/entities/{entity_id}`, never through PATCH.
Optimistic concurrency. Every successful PATCH increments the portfolio's version. Send expected_version (the version you last read) to guard against concurrent writers: a mismatch — or a write that races yours between read and update — returns 409 state_conflict with the expected and actual versions, so re-read and re-apply. Omit expected_version for last-write-wins.
Returns 200 OK with the updated portfolio. Returns 404 not_found if the id does not exist or is not visible to the calling key.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
One of
any
any
any
any
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X PATCH "https://api.mattermode.com/v1/portfolios/{id}" \ -H "Content-Type: application/json" \ -d '{ "name": "Studio Fund I (2026)", "expected_version": 2 }'const body = JSON.stringify({ "name": "Studio Fund I (2026)", "expected_version": 2})fetch("https://api.mattermode.com/v1/portfolios/{id}", { method: "PATCH", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/portfolios/{id}" body := strings.NewReader(`{ "name": "Studio Fund I (2026)", "expected_version": 2 }`) req, _ := http.NewRequest("PATCH", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "name": "Studio Fund I (2026)", "expected_version": 2}resp = requests.patch( "https://api.mattermode.com/v1/portfolios/pf_S4dGqL2c", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "name": "Studio Fund I (2026)", "expected_version": 2}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/portfolios/{id}")) .header("Content-Type", "application/json") .PATCH(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "name": "Studio Fund I (2026)", "expected_version": 2}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PatchAsync("https://api.mattermode.com/v1/portfolios/{id}", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request PATCH 'https://api.mattermode.com/v1/portfolios/pf_S4dGqL2c' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "name": "Studio Fund I (2026)", "expected_version": 2}'const response = await fetch("https://api.mattermode.com/v1/portfolios/pf_S4dGqL2c", { method: "PATCH", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "name": "Studio Fund I (2026)", "expected_version": 2 }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"id": "pf_S4dGqL2c",
"object": "portfolio",
"mode": "test",
"name": "Studio Fund I (2026)",
"shared_registered_agent_id": "ra_X8nB5wPq",
"shared_compliance_calendar": true,
"entity_ids": [
"ent_Nq3KcAbc"
],
"version": 3,
"metadata": {},
"created_at": "2026-04-25T00:00:00Z",
"updated_at": "2026-05-12T09:30:00Z"
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "No entity with id `ent_Nq3KcAbc` is visible to this token.",
"doc_url": "https://mattermode.com/docs/guides/errors#not_found",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/invalid_state_transition",
"title": "Invalid state transition",
"status": 409,
"code": "invalid_state_transition",
"detail": "Entity ent_Nq3KcAbc is in state `dissolved`; `dissolve` is not a valid transition.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_state_transition",
"request_id": "req_Qw9xYz8A",
"current_state": "dissolved",
"attempted_transition": "dissolve",
"allowed_transitions": []
}{
"type": "https://mattermode.com/docs/errors/dissolution_prerequisites_missing",
"title": "Dissolution prerequisites missing",
"status": 409,
"code": "dissolution_prerequisites_missing",
"detail": "Voluntary dissolution requires `board_resolution_id` and `stockholder_consent_id`, or `auto_generate_resolutions: true`.",
"doc_url": "https://mattermode.com/docs/guides/errors#dissolution_prerequisites_missing",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/valuation_stale",
"title": "409A valuation stale",
"status": 409,
"code": "valuation_stale",
"detail": "Active 409A val_AbCd1234 is older than 12 months or superseded by a material event. Issuing ISOs at the prior strike risks IRC §409A violation. Refresh via POST /entities/{id}/valuations/{id}/refresh_request.",
"doc_url": "https://mattermode.com/docs/guides/errors#valuation_stale",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "One or more fields failed validation. See `errors[]`.",
"doc_url": "https://mattermode.com/docs/guides/errors#validation_failed",
"request_id": "req_Qw9xYz8A",
"errors": [
{
"field": "founders[0].equity",
"code": "out_of_range",
"message": "Equity must sum to 100% across all founders."
}
]
}{
"type": "https://mattermode.com/docs/errors/rate_limit_exceeded",
"title": "Rate limit exceeded",
"status": 429,
"code": "rate_limit_exceeded",
"detail": "Request rate exceeded for this key. Retry after `retry_after` seconds or honor the `Retry-After` header.",
"doc_url": "https://mattermode.com/docs/guides/errors#rate_limit_exceeded",
"request_id": "req_Qw9xYz8A",
"retry_after": 30
}