Update an inbound-email alias
PATCH
/v1/aliases/{id}
Update the mutable fields only — routing destinationIds, the allowedSenders allow-list (null clears it), and maxSizeBytes (null clears it). The address + kind are IMMUTABLE.
Authorizations
apiKey
Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Request Body
application/json
JSON "destinationIds": [ "string" ], "allowedSenders": [ "string" ], "maxSizeBytes": 0
{
}
Responses
The updated alias.
application/json
JSON "id": "al_01JX9", "address": "orders.acme@emhk.in", "kind": "platform", "localPart": "orders", "domain": "emhk.in", "destinationIds": [ "string" ], "allowedSenders": [ "string" ], "maxSizeBytes": 26214400, "createdAt": "string"
{
}