Update a forwarding rule
Updates an inbound email forwarding rule and returns its current summary. Use this endpoint to update a forwarding rule through the Samva email API.
PATCH
Updates an inbound email forwarding rule and returns its current summary.
apiKeyheader
x-api-key<token>id*stringMatch
^fwd_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
name?string|nulldescription?string|nulldomainId?|nullsourcePattern?string|nullforwardTo?array<string>|nullpreserveHeaders?boolean|nullappendNote?string|nullconditions?|null|nullpriority?|nullisActive?boolean|nullmetadata?|null|nullSuccess
application/json- response
id*EmailForwardingRuleIdMatch
^fwd_[0-9a-hjkmnp-tv-z]{16,24}$name*stringforwardTo*array<string>priority*integerRange
0 <= value <= 2147483647isActive*booleanupdatedAt*stringimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.updateForwardingRule({ "id": "example"});Example Response
{ "id": "string", "name": "string", "forwardTo": [ "string" ], "priority": 0, "isActive": true, "updatedAt": "string"}