Skip to main content
PATCH
Update a session

Path Parameters

sessionId
string
required
Pattern: ^sid_[0123456789abcdefghjkmnpqrstvwxyz]{26}$
Example:

"sid_87wfetm98myh9awj0dpt28a3kc"

Body

application/json

Send client_user_id, client_application_id, or both. At least one is required. A key you omit keeps its current value, and null clears it.

client_user_id
string | null

Customer-supplied identifier for the end user associated with this Foil session. Set with PATCH /v1/sessions/{sessionId}.

Maximum string length: 256
Example:

"user_123"

client_application_id
string | null

Customer-supplied identifier for the application or organization on your platform that this Foil session belongs to. Set with PATCH /v1/sessions/{sessionId}.

Maximum string length: 256
Example:

"app_123"

Response

Updated session detail response.

data
object
required
Example:
meta
object
required
Example: