Set Up Advanced Forwarding

POST

https://api.inboxkit.com/v1/api/mailboxes/forwarding/setup

Maintainer:Not configured

Forward only the messages that match your conditions. This is the same endpoint as Setup Email Forwarding, with mode: "advanced" and conditions.

match "all": every condition must match.

match "any": at least one condition must match.

A rule is created for each Google domain or Microsoft account and returned in rules. If a mailbox already forwards, the new setup replaces it and replaces shows the old one. Setup takes a few minutes; track it with List Forwarding Jobs.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢200Success Response

application/json

Bodyapplication/json

🟠400Bad Request

🟠404Mailbox Not Found

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "error": false,
    "message": "Forwarding setup jobs created for 2 mailbox(es)",
    "jobs": [
        {
            "mailbox_uid": "mb-123e4567-e89b-12d3-a456-426614174000",
            "forwarding_email": "[email protected]",
            "action": "enable",
            "status": "pending",
            "mode": "off",
            "rule": "string",
            "replaces": {
                "mode": "simple",
                "forwarding_email": "[email protected]",
                "rule": "string"
            },
            "created_at": "2025-01-15T10: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"
            }
        }
    ],
    "rules": [
        {
            "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"
        }
    ]
}

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

Get Forwarding Capabilities

List Forwarding Rules