Update a email account

PUT/api/v1/email-accounts/{account}/forwarding-rules/{rule}
Requires anorganization API keywith the scopemailboxes:write

Parameters

NameInTypeDescription
accountrequiredpathstringThe account identifier.
rulerequiredpathstringThe rule identifier.

Request

PUT/api/v1/email-accounts/{account}/forwarding-rules/{rule}
curl -X PUT 'https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/forwarding-rules/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • objectstringmailbox_forwarding_rule
    • idstring

      Unique identifier for the rule.

    • mailbox_idstring

      The mailbox this rule applies to. Retrieve it with `GET /api/v1/email-accounts/{email_account}`.

    • forward_tostring

      The address mail is forwarded to.

    • conditionobject

      When the rule applies. The two halves travel together because they are meaningless apart.

      • typestringall | from | subject | has_attachment

        `all` forwards everything; `from` and `subject` match `value`; `has_attachment` needs no value.

      • valuestring

        The address or subject fragment matched on. **null when `type` is `all` or `has_attachment`**, where there is nothing to match against — not an unknown value.

    • keep_copyboolean

      Whether the original is also left in the mailbox. False forwards and removes.

    • activeboolean

      Whether the rule is switched on. A plain flag rather than a `state`, because a forwarding rule has no mail-server lifecycle to disagree with it — nothing carries the rule to the mail server, so `true` means the rule is stored and enabled here, which is not the same statement as "mail is being forwarded".

    • created_atstring
    • updated_atstring

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.