WHwhispa
integrations
collexus

Save Collexus Exchange Settings

Save which scenarios the return file covers and which directions run on a schedule, and return the card's status as it now stands.

From the first save these choices replace the deployment's configured defaults. A scenario must be one of this deployment's AI scenarios, and the daily return file cannot be switched on with none chosen. The connection and the account-file freshness gate are not settable here: pausing the scheduled import leaves that gate counting.

put/integrations/collexus/settings

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Request body

return_file_scenariosstring[]
ingest_scheduledboolean
return_file_scheduledboolean

Response

Successful Response

availableboolean required
configuredboolean
missing_settingsstring[]
mode'pinned' | 'discovery' nullable
hoststring nullable
portinteger nullable
usernamestring nullable
inbound_pathstring nullable
outbound_pathstring nullable
settings_savedboolean
ingest_scheduledboolean
return_file_scheduledboolean
return_file_scenariosstring[]
return_file_timezonestring nullable
return_file_deliver_after_hourinteger nullable
freshness_gate_minutesinteger nullable

Changes

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