external-platform

Update Slack Settings

patch/api/external-platform/slack/settings

Request

  • Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.usepomo.ai/api/external-platform/slack/settings
  • Auth: HTTP bearer

Request body

default_channel_idstring nullable
allowlist_patternsstring[] nullable

Optional Slack email allowlist patterns (e.g. *@machflow.ai, user@domain.com, @domain.com)

default_markee_user_idstring uuid nullable

Pomo user that allowlisted Slack users act as. Required before an allowlist can be saved; choose the least-privileged account that can do the work, since every matching Slack user inherits its access.

Response

Successful Response

connectedboolean required

Whether the platform is connected

healthyboolean

Whether the token is healthy (passed API check)

health_messagestring nullable

Health check result message

account_idstring nullable

Platform-specific account identifier

account_namestring nullable

Display name for the account

token_expires_soonboolean

Whether token expires within buffer period

last_health_checkstring nullable

ISO timestamp of last health check

rollout_admittedboolean
rollout_reasonstring
connect_allowedboolean
reauthorization_requiredboolean

The profile is still bound to a workspace, but Slack no longer accepts Pomo's token for it (the app was removed or the token revoked). Nothing can be posted until someone reconnects.

team_idstring nullable
team_namestring nullable
workspace_urlstring nullable
bot_user_idstring nullable
default_channel_idstring nullable
linked_slack_user_idstring nullable
linked_slack_user_namestring nullable
allowlist_patternsstring[]
scopesstring[]
noticesstring[]

Plain-language explanations of anything in the request that was not applied. Not-yet-having-access is an expected state, not an error, so it is reported here and the rest of the settings still save. The other fields always reflect what is actually stored, so the caller can see what did and did not take effect.

Example response

{
  "account_id": "shop_12345",
  "account_name": "My Store",
  "connected": true,
  "health_message": "Token is valid",
  "healthy": true,
  "last_health_check": "2024-01-15T10:30:00Z",
  "token_expires_soon": false
}

Changes

No recorded changes to this operation across all 1 revision of this API.