Update a single forward rule by ID

Request

All parameters are optional, only the provided fields will be updated

Security

basicAuth

Path

idstringrequired

The ID of the forward rule

Query

matchstringrequired

A wildcard expression which matches the recipient address to forward. This is a insensitive match address

forward.urlstringrequired

A URL to forward when the rule matches the recipient. May be repeated up to 3 times. Must be a valid URL that resolves

forward.recipientstringrequired

A email address to forward to when the rule matches the recipient. May be repeated up to 5 times

forward.storestringrequired

A URL which will be used to notify you when the email arrives along with a URL you can use to retrieve the message. Must be a valid URL that resolves

curl -i -X PUT \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/forwards/{id}?match=string&forward.url=string&forward.recipient=string&forward.store=string'

Responses

A 200 response

Bodyapplication/json

idstringrequired

account_idstringrequired

domain_namestringrequired

domain_idstringrequired

matchstringrequired

forwardobject(github.com-mailgun-pathfinder-httpapi-Forward)required

created_atstringrequired

updated_atstringrequired

Response

{
  "id": "60d9431e582ecdc84b886284",
  "account_id": "646634cc58ea2b8fe43e0000",
  "domain_name": "my-domain.com",
  "domain_id": "642134nn58ea2b8fe43e0000",
  "match": "wild*card@example.com",
  "forward": {
    "urls": [ … ],
    "recipients": [ … ],
    "store": "https://my-store-url.com/store"
  },
  "created_at": "Mon, 28 Jun 2021 03:33:50 UTC",
  "updated_at": "Mon, 28 Jun 2021 03:33:50 UTC"
}