Update Recipient Session
PATCH /v2/widget/recipient-session
Operation
| Operation ID | updateRecipientSession |
| Tags | Untagged |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| locale_override | locale | BCP-47 locale tag (e.g. en-US, es-MX). |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | recipient_session |
| contact_id * | id | UUID v4. |
| journey_id * | id | UUID v4. |
| widget_instance_id * | id | UUID v4. |
| locale_override | locale | BCP-47 locale tag (e.g. en-US, es-MX). |
| started_at * | emitted_at | RFC 3339 / ISO 8601 timestamp. |
| last_activity_at * | emitted_at | RFC 3339 / ISO 8601 timestamp. |
| expires_at * | emitted_at | RFC 3339 / ISO 8601 timestamp. |
| resumed_count * | integer | |
| is_active * | boolean |
Example request
PATCH https://api.digitalonboarding.com/v2/widget/recipient-session
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }