TEteaflask
authed

Delete Steep Session

Deletes one journey: it leaves every list at once and takes no more events, and its data is removed from storage after. Deleting it again answers the same receipt.

delete/api/v1/steep/sessions/{session_id}

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/steep/sessions/{session_id}
  • Auth
    none declared

Path parameters

session_idstring uuid required

Response

Successful Response

idstring uuid required

The deletion's id.

scope'session' | 'end_user' required
session_idstring uuid nullable required

The journey deleted; null for an end user's deletion.

end_user_idstring nullable required

The end user whose journeys were deleted; null for one journey's deletion, and null once the deletion is 2 days old.

requested_atstring date-time required

When the deletion was asked for.

status'pending' | 'completed' required
deleted_session_countinteger required

How many journeys the deletion removed; 0 for an end user with none stored yet.

completed_atstring date-time nullable required

When the data was gone from storage; null while pending.

Changes

No recorded changes to this operation across all 1 revision of this API.