Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Body

application/json
textItemIds
string[]
required

Developer IDs of the text items to unlink from their library component. Each must currently be a library instance. Every text item linked to a component shares that component's developer ID with its sibling instances, so a given developer ID unlinks every text item that currently carries it, not just one — scope this with projectId to affect only the instances in one project.

Minimum array length: 1
projectId
string

Developer ID of the project to scope the unlink to. If provided, only instances of the given developer IDs within this project are unlinked; instances in other projects are left untouched. If omitted, every instance of each given developer ID is unlinked, regardless of project.

Response

Returns success status of the unlink operation and the number of text items actually unlinked

success
boolean
required

Indicates whether the unlink operation was successful

unlinkedCount
number
required

The number of text items actually unlinked. This can exceed the number of developer IDs given, since every instance sharing a given developer ID is unlinked.