---
title: "Update Collect Session"
method: PUT
path: "/collect/sessions/{session_id}"
tags: ["Collect Sessions"]
---

# Update Collect Session

`PUT /collect/sessions/{session_id}`

Edit properties of a collect session.

## Path parameters

- `session_id` string, required

## Request body

- object
  - `expired` boolean — Set whether the collect session is expired or not. An expired session can be reactivated at any time.

## Response `200`

Successfully updated the collect session.

- AdvancedCollectSession
  - `id` string, uuid — Unique identifier for the object.
  - `url` string — The URL for the session. The first UUID in the URL is a unique identifier for your organisation that will be static accross Collect sessions. The second UUID in the URL is the session id.
  - `customer_id` string, uuid — Unique identifier for the associated customer.
  - `created_at` string, date-time — Time at which the session was created. In the format: yyyy-MM-dd'T'HH:mm:ssZ
  - `completed_at` string, nullable — Time at which the session was completed. This will be null if the session has not been completed. In the format: yyyy-MM-dd'T'HH:mm:ssZ
  - `success_url` string — The URL the user will be redirected to when they complete the session.
  - `cancel_url` string — The URL the user will be redirected to when they abort or cancel the session.
  - `logo_url` string — A link to the logo displayed in the collect session.
  - `display_name` string — The name of the company being displayed in the collect session.
  - `expired` boolean — States if the session is active

## Other responses

- `400` — You have provided incorrect data.
- `403` — You do not have permission to access this resource.
- `404` — The specified resource was not found.
- `429` — Too many requests. The request has been rate limited. For more information, visit our [documentation on rate limiting](https://docs.inscribe.ai/docs/are-the-endpoints-rate-limited).

---

[API](https://skmtc.dev/inscribe/apis/core-resources.md) · [All operations](https://skmtc.dev/inscribe/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inscribe/core-resources/revisions/6489b36eb60f/schema)