Session configuration
The session configuration object
Attributes
requestedHistoryobjectrequiredStructured requested history values for this management session configuration view.
Show 3 child fields
historyConsentstringSpecifies history consent for this management session configuration view.
Allowed valuespendingaccepteddeclinedeffectiveobjectrequiredStructured effective values for this management session configuration view.
Show 3 child fields
overridesobjectrequiredStructured overrides values for this management session configuration view.
Show 3 child fields
sourcesobjectrequiredStructured sources values for this management session configuration view.
Show 8 child fields
revisionsobjectrequiredStructured revisions values for this management session configuration view.
Show 3 child fields
applicationobjectStructured application values for this management session configuration view.
Show 3 child fields
{
"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
- 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
projectIdstringIdentifier of the Polymorfa project that owns this resource.
Responses
200Success
dataobjectrequiredStructured 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.
curl "https://api.polymorfa.com/platform/session-configuration" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"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
- 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.
revisionintegerrequiredmin0Specifies revision for this management session configuration update request.
configurationobjectrequiredStructured configuration values for this management session configuration update request.
Show 2 child fields
Responses
200Success
dataobjectrequiredStructured 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.
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"
]
}
}'{
"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
}
}
}