Update Forwarding Rule

POST

https://api.inboxkit.com/v1/api/mailboxes/forwarding/rules/{uid}/update

Maintainer:Not configured

Change a rule's conditions, match, forwarding address or mailboxes. Send only what changes. uids is the full list of mailboxes: any you leave out stop forwarding. The rule shows status pending until the change is live.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success Response

application/json

Bodyapplication/json

🟠400Bad Request

🟠404Rule Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.inboxkit.com/v1/api/mailboxes/forwarding/rules//update' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "forwarding_email": "[email protected]",
    "match": "all",
    "conditions": [
        {
            "location": "subject",
            "header_name": "X-Autoreply",
            "match": "regex",
            "value": "out of office"
        }
    ],
    "uids": [
        "string"
    ]
}'

Response Example

200 - Example 1

{
    "error": false,
    "message": "Forwarding rule updated; changes are applied in the background",
    "rule": {
        "uid": "9b2f7c1e-0d4a-4b8e-9a51-3f0c6d2e8a17",
        "platform": "GOOGLE",
        "scope": "google",
        "match": "all",
        "conditions": [
            {
                "location": "subject",
                "header_name": "X-Autoreply",
                "match": "regex",
                "value": "out of office"
            }
        ],
        "forwarding_email": "[email protected]",
        "mailboxes": [
            {
                "uid": "mb-123e4567-e89b-12d3-a456-426614174000",
                "email": "[email protected]"
            }
        ],
        "status": "pending",
        "last_error": "string",
        "applied_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2026-11-05T10:30:00.000Z",
        "updated_at": "2026-11-05T10:30:00.000Z"
    },
    "mailboxes": [
        {
            "uid": "mb-123e4567-e89b-12d3-a456-426614174000",
            "mode": "off",
            "rule": "string",
            "status": "pending",
            "replaces": {
                "mode": "simple",
                "forwarding_email": "[email protected]",
                "rule": "string"
            }
        }
    ]
}

Modified at 2026-11-05 15:01:16

Get Forwarding Rule

Delete Forwarding Rule