Setup Email Forwarding

POST

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

Maintainer:Not configured

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

Body

🟠404Mailbox Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '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]"
}'

Response Example

200 - Example 1

{
    "error": false,
    "message": "Forwarding setup jobs created for 2 mailbox(es)",
    "jobs": [
        {
            "uid": "fwd-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "mailbox_uid": "mb-123e4567-e89b-12d3-a456-426614174000",
            "forwarding_email": "[email protected]",
            "action": "enable",
            "status": "pending",
            "created_at": "2025-01-15T10:30:00.000Z"
        }
    ]
}

Modified at 2025-11-13 15:09:40

List Client ID Requests

Update Email Forwarding