Skip to main content
PATCH
Upsert session meta

Authorizations

Authorization
string
header
required

Behalf of a Plugin Connection. Issued when a plugin is installed on a specific tenant; scoped strictly to that one tenant. Send as Authorization: PluginConnection base64(pluginConnectionID:pluginConnectionToken).

Path Parameters

tenantID
string<uuid>
required

The tenant the session belongs to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
sessionID
string<uuid>
required

The session whose data is written.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
metaKey
string
required

Key to write under sessionMeta.custom: lowercase letters, digits, "_" and "-" (1 to 64 chars).

Pattern: ^[a-z0-9_-]{1,64}$
metaValue
string | null
required

Value to store; null removes the key.

Maximum string length: 2000

Response

Response for status 200.

session
object
required

The session after the write.