Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Forwarding

Manage forwarding rules and forwarding addresses. The examples use A2A code mode. MCP exposes the same code mode through its execute tool.

​
Functions

​
forwarding.activate

forwarding.activate(account_id: str, forwarding_id: str, active: bool) -> ForwardingRule
Update forwarding active state.
PropertyValuePropertyValue
Requires permissionforwarding.manageAuth requiredyes
Execution modesyncCapabilityforwarding.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/active
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
forwarding_idstryesForwarding rule UUID from the route path
activeboolyesWhether forwarding should be active
FieldTypeRequiredDescription
activeboolyesWhether forwarding is active
created_atstryesForwarding rule creation timestamp
idstryesForwarding rule UUID
scope_idstryesResource UUID for the forwarding scope
scope_type"account" | "workspace" | "domain"yesResource scope type for the forwarding rule
target_emailstryesForwarding destination email address
updated_atstryesForwarding rule last update timestamp
verification_requiredboolyesWhether recipient verification is required
verification_state"internal" | "pending" | "verified" | "expired"yesRecipient verification state
verification_expires_atstr | nullnoVerification expiry timestamp
verification_sent_atstr | nullnoVerification email sent timestamp
verification_verified_atstr | nullnoVerification completion timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.activate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", active=true)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.activate",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.activate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", active=true)"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.activate\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
forwarding.add

forwarding.add(account_id: str, target_email: str, domain?: str | null, workspace_id?: str | null) -> ForwardingRule
Create forwarding.
PropertyValuePropertyValue
Requires permissionforwarding.manageAuth requiredyes
Execution modesyncCapabilityforwarding.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/forwarding
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
target_emailstryesForwarding destination email address
domainstr | nullnoDomain UUID or domain name scope for the forwarding rule
workspace_idstr | nullnoWorkspace UUID scope for the forwarding rule
FieldTypeRequiredDescription
activeboolyesWhether forwarding is active
created_atstryesForwarding rule creation timestamp
idstryesForwarding rule UUID
scope_idstryesResource UUID for the forwarding scope
scope_type"account" | "workspace" | "domain"yesResource scope type for the forwarding rule
target_emailstryesForwarding destination email address
updated_atstryesForwarding rule last update timestamp
verification_requiredboolyesWhether recipient verification is required
verification_state"internal" | "pending" | "verified" | "expired"yesRecipient verification state
verification_expires_atstr | nullnoVerification expiry timestamp
verification_sent_atstr | nullnoVerification email sent timestamp
verification_verified_atstr | nullnoVerification completion timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\", domain=\"example.com\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.add",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\", domain=\"example.com\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.add\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
forwarding.delete

forwarding.delete(account_id: str, forwarding_id: str) -> {}
Delete forwarding.
PropertyValuePropertyValue
Requires permissionforwarding.manageAuth requiredyes
Execution modesyncCapabilityforwarding.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/forwarding/{forwarding_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
forwarding_idstryesForwarding rule UUID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {}\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
forwarding.list

forwarding.list(account_id: str, page?: int, page_size?: int) -> Page[ForwardingRule]
List forwarding.
PropertyValuePropertyValue
Requires permissionforwarding.viewAuth requiredyes
Execution modesyncCapabilityforwarding.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/forwarding
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
pageintnoOne-based forwarding rule page number
page_sizeintnoMaximum forwarding rules per page
FieldTypeRequiredDescription
items[{"active": bool, "created_at": str, "id": str, "scope_id": str, "scope_type": "account" | "workspace" | "domain", "target_email": str, "updated_at": str, "verification_required": bool, "verification_state": "internal" | "pending" | "verified" | "expired", "verification_expires_at"?: str | null, "verification_sent_at"?: str | null, "verification_verified_at"?: str | null}]yesForwarding rules on this page
pageintyesCurrent one-based page number
page_sizeintyesMaximum items per page
totalintyesTotal matching forwarding rules
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.list",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.list\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
forwarding.update

forwarding.update(account_id: str, forwarding_id: str, target_email: str) -> ForwardingRule
Update forwarding.
PropertyValuePropertyValue
Requires permissionforwarding.manageAuth requiredyes
Execution modesyncCapabilityforwarding.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
forwarding_idstryesForwarding rule UUID from the route path
target_emailstryesForwarding destination email address
FieldTypeRequiredDescription
activeboolyesWhether forwarding is active
created_atstryesForwarding rule creation timestamp
idstryesForwarding rule UUID
scope_idstryesResource UUID for the forwarding scope
scope_type"account" | "workspace" | "domain"yesResource scope type for the forwarding rule
target_emailstryesForwarding destination email address
updated_atstryesForwarding rule last update timestamp
verification_requiredboolyesWhether recipient verification is required
verification_state"internal" | "pending" | "verified" | "expired"yesRecipient verification state
verification_expires_atstr | nullnoVerification expiry timestamp
verification_sent_atstr | nullnoVerification email sent timestamp
verification_verified_atstr | nullnoVerification completion timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.update",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.update\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
forwarding.verification.confirm

forwarding.verification.confirm(account_id: str, forwarding_id: str, code: str) -> ForwardingRule
Confirm forwarding verification.
PropertyValuePropertyValue
Requires permissionforwarding.manageAuth requiredyes
Execution modesyncCapabilityforwarding.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/confirm
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
forwarding_idstryesForwarding rule UUID from the route path
codestryesForwarding verification code
FieldTypeRequiredDescription
verifiedboolyesWhether forwarding verification succeeded
forwarding_idstr | nullnoForwarding rule UUID
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.verification.confirm(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", code=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.verification.confirm",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.verification.confirm(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", code=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.verification.confirm\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
forwarding.verification.send

forwarding.verification.send(account_id: str, forwarding_id: str) -> ForwardingRule
Send forwarding verification.
PropertyValuePropertyValue
Requires permissionforwarding.manageAuth requiredyes
Execution modesyncCapabilityforwarding.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/send
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
forwarding_idstryesForwarding rule UUID from the route path
FieldTypeRequiredDescription
cooldown_secondsintyesSeconds before another verification email can be sent
sentboolyesWhether a verification email was sent
expires_atstr | nullnoVerification expiry timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "forwarding.verification.send(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "forwarding.verification.send",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "forwarding.verification.send(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"forwarding.verification.send\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}