SDK API Reference / SegmentFolderDetails

Interface: SegmentFolderDetails

Segment folder details response - JSON:API format (from show endpoint)

Properties

attributes

attributes: object

audienceId

audienceId: string

createdAt?

optional createdAt?: string

description?

optional description?: string | null

enrichments?

optional enrichments?: unknown

name

name: string

permissions?

optional permissions?: object

permissions.edit

edit: boolean

permissions.view

view: boolean

rule?

optional rule?: unknown

updatedAt?

optional updatedAt?: string

---

id

id: string

---

relationships?

optional relationships?: object

createdBy?

optional createdBy?: object

createdBy.data

data: object

createdBy.data.id

id: string

createdBy.data.type

type: string

parentFolder?

optional parentFolder?: object

parentFolder.data

data: { id: string; type: string; } | null

updatedBy?

optional updatedBy?: object

updatedBy.data

data: object

updatedBy.data.id

id: string

updatedBy.data.type

type: string

---

type

type: string