Components

Unlink text items from a component

Unlinks one or more text items from their library component by developer ID.

Each unlinked text item keeps its current text but gets a freshly generated developer ID, and future edits to the library component no longer affect it. 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. Pass projectId to scope the unlink to only the instances in one project, leaving instances elsewhere untouched.

patch/components/unlink

Request

  • Base URL: https://api.dittowords.com/v2
  • URL: https://api.dittowords.com/v2/components/unlink
  • Auth: API key in header Authorization

Request body

textItemIdsstring[] 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.

projectIdstring

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.

Example request

{
  "textItemIds": [
    "text-item-id-1",
    "text-item-id-2"
  ]
}

Response

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

successboolean required

Indicates whether the unlink operation was successful

unlinkedCountnumber 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.

Example response

{
  "success": true,
  "unlinkedCount": 1
}

Changes

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