InboxKit
  1. Mailbox Forwarding
InboxKit
  • Introduction
  • Order
    • Place Order
      POST
  • Webhook
    • Status Change Webhook
      POST
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Get workspace details
      GET
    • Create workspace
      POST
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Search available domains
      POST
    • Check if domain is banned from registration
      GET
    • Check domain availability
      GET
    • Register domains
      POST
    • List domains
      POST
    • List assignable domains
      GET
    • Remove domains
      POST
    • Set domain forwarding
      POST
    • Set catch-all email
      POST
    • Remove catch-all email
      DELETE
    • Get nameservers for domain connection
      POST
    • Check nameservers propagation
      POST
    • Check Workspace Availability
      POST
    • Set DMARC Configuration
      POST
    • Remove DMARC Configuration
      DELETE
  • Mailboxes
    • List mailboxes
    • Show mailbox credentials
    • Get mailbox details
    • Buy mailboxes
    • Check mailbox status
    • Cancel mailboxes
    • Update mailbox
    • Update mailbox profile picture
    • Generate TOTP
    • Change username
    • Change password
    • Check mailbox availability
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
  • Billing
    • Get pricing plans
    • Get subscription details
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Add credits to wallet
    • Update auto top-up settings
    • Get billing portal link
  • Client ID Requests
    • Initiate Client ID Request
    • Get Client ID Request Status
    • List Client ID Requests
  • Mailbox Forwarding
    • Setup Email Forwarding
      POST
    • Update Email Forwarding
      POST
    • Remove Email Forwarding
      POST
    • List Forwarding Jobs
      POST
  • Consent Request
    • Initiate Consent Request
    • Get Consent Request Status
    • List Consent Requests
  • Tags
    • Assign tags to domains or mailboxes
    • Get all tags
    • Create a new tag
    • Delete a tag
  • Prewarm
    • Search Domains
    • Search Mailboxes
    • Buy Prewarmed Mailboxes
    • Check Order Status
    • Check Availability
  • Inbox Placement
    • Tests
      • Create Test
      • List Tests
      • Get Test Results
    • Scheduled Tests
      • List Scheduled Tests
      • Get Scheduled Test
      • Pause Scheduled Test
      • Resume Scheduled Test
      • Delete Scheduled Test
  1. Mailbox Forwarding

Update Email Forwarding

POST
https://api.inboxkit.com/v1/api/mailboxes/forwarding/update
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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.inboxkit.com/v1/api/mailboxes/forwarding/update' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uids": [
        "string"
    ],
    "forwarding_email": "string"
}'
Response Response Example
200 - Example 1
{
    "error": false,
    "message": "Forwarding update jobs created for 1 mailbox(es)",
    "jobs": [
        {
            "uid": "fwd-c3d4e5f6-g7h8-9012-cdef-gh3456789012",
            "mailbox_uid": "mb-123e4567-e89b-12d3-a456-426614174000",
            "forwarding_email": "[email protected]",
            "action": "update",
            "status": "pending",
            "created_at": "2025-01-15T11:45:30.000Z"
        }
    ]
}
Modified at 2025-11-13 15:09:40
Previous
Setup Email Forwarding
Next
Remove Email Forwarding
Built with