Skip to navigation

Test a mailbox connection

Configure workspace channels. Requires integrations.manage or workspace.manage. API credentials are write-only; copy generated values before saving.

Required permissions: integrations.manage OR workspace.manage.

Authentication

AuthorizationBearer

Kinde access token with the configured LogicDialog audience and workspace membership/permissions. Channel API keys cannot authenticate management operations.

Path parameters

workspaceIdstringRequired

Query parameters

branchstringOptional

Explicit workstream branch. Writes reject main/live. Example: change/WORKSPACE/knowledge-update.

Request

This endpoint expects an object.
mailboxmap from strings to anyRequired
directionenumRequired
Allowed values:
branchstringOptional

Response

Successful operation

Errors

401
Unauthorized Error
403
Forbidden Error