Collect Sessions

Update Collect Session

Changed on

Edit properties of a collect session.

put/collect/sessions/{session_id}

Request

  • Base URL
    https://api.inscribe.ai/api/v2
  • Auth
    API key in header Authorization

Path parameters

session_idstring required

The id of the collect session to return.

Request body

expiredboolean

Set whether the collect session is expired or not. An expired session can be reactivated at any time.

Response

Successfully updated the collect session.

idstring uuid

Unique identifier for the object.

urlstring

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_idstring uuid

Unique identifier for the associated customer.

created_atstring date-time

Time at which the session was created. In the format: yyyy-MM-dd'T'HH:mm:ssZ

completed_atstring 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_urlstring

The URL the user will be redirected to when they complete the session.

cancel_urlstring

The URL the user will be redirected to when they abort or cancel the session.

logo_urlstring

A link to the logo displayed in the collect session.

display_namestring

The name of the company being displayed in the collect session.

expiredboolean

States if the session is active

Example response

{
  "id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "url": "https://collect.inscribe.ai/#/fa207be0-b4da-4234-a350-fbbfe3b3298c/d1e07ab9-36a6-43eb-a550-2bc77dce8afc",
  "customer_id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "created_at": "2019-12-12T15:35:08.460Z",
  "completed_at": "2019-12-12T15:35:08.460Z",
  "success_url": "https://example.com/#success?session_id=0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "cancel_url": "https://example.com/#cancel?session_id=0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "logo_url": "https://assets.website-files.com/5ea61a1bf0e208bb1c5737ac/5ec69023b5341a114ab26bc7_inscribe_logo.svg",
  "display_name": "Inscribe"
}

Changes

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • warning

      added the new EIN_ASSIGNMENT_NOTICE enum value to the ///////// response property for the response status

    • warning

      added the new OPERATING_AGREEMENT enum value to the ///////// response property for the response status

    • info

      added the required property //////// to the response with the status