Skip to content
Shortcut: /, ⌘K or Ctrl+K

Session configuration

View as Markdown

The session configuration object

Attributes

  • requestedHistoryobjectrequired

    Structured requested history values for this management session configuration view.

    Show 3 child fields
  • historyConsentstring

    Specifies history consent for this management session configuration view.

    Allowed valuespendingaccepteddeclined
  • effectiveobjectrequired

    Structured effective values for this management session configuration view.

    Show 3 child fields
  • overridesobjectrequired

    Structured overrides values for this management session configuration view.

    Show 3 child fields
  • sourcesobjectrequired

    Structured sources values for this management session configuration view.

    Show 8 child fields
  • revisionsobjectrequired

    Structured revisions values for this management session configuration view.

    Show 3 child fields
  • applicationobject

    Structured application values for this management session configuration view.

    Show 3 child fields
The session configuration object
{
  "requestedHistory": {
    "mode": "metadata_only",
    "requestFull": true,
    "delivery": "archive"
  },
  "historyConsent": "pending",
  "effective": {
    "observation": {
      "presenceMode": "off",
      "typingMode": "off",
      "labelMode": "off",
      "quickReplyMode": "off"
    },
    "historySync": {
      "mode": "metadata_only",
      "requestFull": true,
      "delivery": "archive"
    },
    "hms": {
      "enabled": false
    }
  },
  "overrides": {
    "historySync": {
      "mode": "metadata_only",
      "requestFull": true,
      "delivery": "descriptor"
    },
    "hms": {
      "enabled": false
    },
    "observation": {
      "presenceMode": "off",
      "typingMode": "off",
      "labelMode": "off",
      "quickReplyMode": "off"
    }
  },
  "sources": {
    "observation.presenceMode": "platform",
    "observation.typingMode": "platform",
    "observation.labelMode": "platform",
    "observation.quickReplyMode": "platform",
    "historySync.mode": "platform",
    "historySync.requestFull": "platform",
    "historySync.delivery": "platform",
    "hms": "platform"
  },
  "revisions": {
    "team": 0,
    "project": 0,
    "session": 0
  },
  "application": {
    "desiredGeneration": 0,
    "appliedGeneration": 0,
    "status": "pending"
  }
}

Get session configuration defaults

GET/platform/session-configurationPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:read

Returns effective team or project defaults, explicit overrides, and their source.

Requires sessions:read. Project tokens only access resources in their own project.

Query parameters

  • projectIdstring

    Identifier of the Polymorfa project that owns this resource.

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 7 child fields
    Show 3 headers
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 404The requested resource was not found inside the authenticated team or project scope.
GET /platform/session-configurationcURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/session-configuration" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "data": {
    "requestedHistory": {
      "mode": "metadata_only",
      "requestFull": true
    },
    "effective": {
      "observation": {
        "presenceMode": "off",
        "typingMode": "off",
        "labelMode": "off",
        "quickReplyMode": "off"
      },
      "historySync": {
        "mode": "metadata_only",
        "requestFull": true
      },
      "hms": {
        "enabled": false
      }
    },
    "overrides": {
      "historySync": {
        "mode": "metadata_only",
        "requestFull": true,
        "delivery": "descriptor"
      },
      "hms": {
        "enabled": false
      },
      "observation": {
        "presenceMode": "off",
        "typingMode": "off",
        "labelMode": "off",
        "quickReplyMode": "off"
      }
    },
    "sources": {
      "observation.presenceMode": "platform",
      "observation.typingMode": "platform",
      "observation.labelMode": "platform",
      "observation.quickReplyMode": "platform",
      "historySync.mode": "platform",
      "historySync.requestFull": "platform",
      "hms": "platform"
    },
    "revisions": {
      "team": 0,
      "project": 0,
      "session": 0
    }
  }
}

Update session configuration defaults

PUT/platform/session-configurationPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:manage

Updates explicit defaults using a revision check. Existing sessions inherit fields they have not overridden. Switching an existing Number to descriptor history delivery requires confirmed cleanup; otherwise the entire update returns 409 and nothing is saved. A reset can inherit descriptor delivery and has the same requirement. Runtime application is asynchronous.

Requires sessions:manage. Project tokens only access resources in their own project.

Body

  • projectIdstring (uuid)

    Identifier of the Polymorfa project that owns this resource.

  • revisionintegerrequiredmin0

    Specifies revision for this management session configuration update request.

  • configurationobjectrequired

    Structured configuration values for this management session configuration update request.

    Show 2 child fields

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 7 child fields
    Show 3 headers
  • 400A path, query, or request-body value did not pass validation.
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 404The requested resource was not found inside the authenticated team or project scope.
  • 409The request conflicts with the resource's current state.
PUT /platform/session-configurationcURL
Not available with the Test key. Use a team key or project token.
curl -X PUT "https://api.polymorfa.com/platform/session-configuration" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "revision": 0,
  "configuration": {
    "set": {
      "historySync": {
        "mode": "metadata_only",
        "requestFull": true,
        "delivery": "descriptor"
      },
      "hms": {
        "enabled": false
      },
      "observation": {
        "presenceMode": "off",
        "typingMode": "off",
        "labelMode": "off",
        "quickReplyMode": "off"
      }
    },
    "reset": [
      "historySync"
    ]
  }
}'
Response
{
  "data": {
    "requestedHistory": {
      "mode": "metadata_only",
      "requestFull": true
    },
    "effective": {
      "observation": {
        "presenceMode": "off",
        "typingMode": "off",
        "labelMode": "off",
        "quickReplyMode": "off"
      },
      "historySync": {
        "mode": "metadata_only",
        "requestFull": true
      },
      "hms": {
        "enabled": false
      }
    },
    "overrides": {
      "historySync": {
        "mode": "metadata_only",
        "requestFull": true,
        "delivery": "descriptor"
      },
      "hms": {
        "enabled": false
      },
      "observation": {
        "presenceMode": "off",
        "typingMode": "off",
        "labelMode": "off",
        "quickReplyMode": "off"
      }
    },
    "sources": {
      "observation.presenceMode": "platform",
      "observation.typingMode": "platform",
      "observation.labelMode": "platform",
      "observation.quickReplyMode": "platform",
      "historySync.mode": "platform",
      "historySync.requestFull": "platform",
      "hms": "platform"
    },
    "revisions": {
      "team": 0,
      "project": 0,
      "session": 0
    }
  }
}