Update Action

Update an existing action on an alias.

PATCH /domains/:domain_name/aliases/:alias_id/actions/:action_id

Example: /domains/example.com/aliases/alias_01k3tgwp77ee2817s5sz5avbza/actions/action_01k3tgwp78exbvj1py42gs65z4

Send only the fields you want to change. The response is the full updated alias (including all actions) with status 200 OK.

Path Parameters

domain_name string required

The domain name that owns the alias.

alias_id string required

The ID of the alias that contains the action.

action_id string required

The ID of the action to update.

Body Parameters

Partial action object. Only include fields you want to change. See Create Alias - Action Types for valid fields per action type.

Example (change forward recipient):

curl -X PATCH https://api.mailcast.io/v1/domains/:domain_name/aliases/:alias_id/actions/:action_id \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d $'{
  "recipient": "help@company.com"
}'

Response 200

{
  "id": "alias_01k3tgwp77e4086gczr87tyh70",
  "match": "support",
  "state": "active",
  "actions": [
    {
      "id": "action_01k3tgwp78e7dva0q3n9fv5sk5",
      "type": "forward",
      "state": "active",
      "recipient": "help@company.com"
    }
  ],
  "created_at": "2025-08-29T12:00:00Z",
  "updated_at": "2025-08-29T13:30:00Z"
}