Skip to content

Archive Transcript

PATCH
/customer-success/transcripts/{transcript_id}/archive

Take a transcript out of the client’s view.

REVERSIBLE - /unarchive puts it back, and nothing is deleted. It is still tiered destructive, because that is what the shared /archive rule derives for every archive route in the contract and an exception here would make the tier mean two things.

No company gate on the route: this is addressed by transcript, not by company, so the caller’s company scope is what authorises it - exactly as the app has it.

Authorizations

Parameters

Path Parameters

transcript_id
required

Transcript id.

string

Transcript id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a single role, team, member or account record.

Open on purpose. The app’s own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as “they do not have it”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string