API · Manage · Mail
Forward mail.
Relay a piece of mail to a destination outside Matter — typically an attorney, accountant, or co-founder who needs the original scan plus any OCR-extracted structured data. The mail item itself stays in the entity's inbox; forwarding is purely additive.
Forwarding methods (method) - email — send the PDF and a JSON payload of extracted fields to the supplied address. Delivery is logged on the mail item's forwarding array within seconds. - physical_mail — print and post the original document to a postal address. Used for lawsuits and tax notices that counsel needs in hard copy. Adds 3–5 business days; the cost is debited from the account.
Forwarding does not change the mail item's status — call acknowledge, respond, or escalate separately to advance the workflow.
Returns 202 Accepted. On completion, emits one of: mail.acknowledged, mail.escalated, mail.responded. Subscribe via `POST /v1/webhook_endpoints` to consume. Idempotent via Idempotency-Key. See idempotency.
See also: Mail API overview.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
methodstringRequired"email""physical_mail"destinationstringRequiredEmail address when method=email, street address string when method=physical_mail.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/mail/{id}/forward" \ -H "Content-Type: application/json" \ -d '{ "method": "email", "destination": "string" }'const body = JSON.stringify({ "method": "email", "destination": "string"})fetch("https://api.mattermode.com/v1/mail/{id}/forward", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/mail/{id}/forward" body := strings.NewReader(`{ "method": "email", "destination": "string" }`) req, _ := http.NewRequest("POST", 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 = { "method": "email", "destination": "string"}resp = requests.post( "https://api.mattermode.com/v1/mail/mail_F2sQwLtR/forward", 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("""{ "method": "email", "destination": "string"}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/mail/{id}/forward")) .header("Content-Type", "application/json") .POST(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("""{ "method": "email", "destination": "string"}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/mail/{id}/forward", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/mail/mail_F2sQwLtR/forward' \ --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 '{ "method": "email", "destination": "string"}'const response = await fetch("https://api.mattermode.com/v1/mail/mail_F2sQwLtR/forward", { method: "POST", 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({ "method": "email", "destination": "string" }),});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": "mail_Nq3KcAbc",
"object": "mail_item",
"entity_id": "ent_Nq3KcAbc",
"source": "registered_agent_scan",
"category": "service_of_process",
"status": "received",
"sender": {},
"return_address": {
"line1": "548 Market St",
"city": "San Francisco",
"region": "CA",
"postal_code": "94104",
"country": "US"
},
"subject": "string",
"ocr_text": "string",
"extracted": {},
"response_deadline": 0,
"received_at": 0,
"scanned_at": 0,
"scan_document_id": "string",
"response_document_id": "string",
"related_filing_id": "string",
"escalation_authorization_id": "string",
"forwarding": {},
"metadata": {},
"created": 1745539200,
"updated": 1745539200,
"livemode": false
}{
"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/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
}