Unlink a player from their Lingara account

API version 2026-10-virile-dragon

delete https://api.getlingara.com/v1/embed/players/{player_ref}/link

Ends a player's link. The player plays as your guest again from the next call. Nothing moves back: what the link carried stays in the learner's account. A player with no live link, or one already unlinked, answers 404 embed_link_not_found.

Scopes embed:mint

Parameters

Lingara-Versionheaderstringoptional: The API version to answer this request under. Without it, an access token gets the version its client is pinned to, and a request with no token gets the current version. The version still in development is reached only by naming it here. An unknown version answers 400 with code api_version_unknown. GET /v1/versions lists the versions.
player_refpathstringrequired: The player_ref you minted the player's tokens with, percent-encoded: guild/42 is guild%2F42.

Responses

204 The link has ended

Errors

410application/json: The API version this request is answered under has been discontinued. Send a supported version in Lingara-Version, or re-pin the client.
4XXapplication/json: The request was refused. code says why, and error says it in words.
503application/json · text/plain: The service is temporarily unavailable; retry after the number of seconds in Retry-After. During maintenance the body is plain text rather than the error envelope.
5XXapplication/json: The request was refused. code says why, and error says it in words.

codestringrequired: Why the request was refused, as a stable code to branch on: for example insufficient_scope (403), rate_limited (429) and, for a metered client, spend_cap_reached (402) and metered_billing_inactive (402).
errorstringrequired

Example

curl -X DELETE "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Prefer a library? See the Libraries section.