You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a03dcb1
Browse filesBrowse the repository at this point in the historyBrowse files
description: Unlinks a single child key from a given parent key.
34880
+
description: |
34881
+
Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context.
34882
+
34883
+
Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects.
34884
+
34885
+
It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.
Copy file name to clipboardExpand all lines: docs/LinkedKeysApi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -185,7 +185,7 @@ Name | Type | Description | Notes
185
185
186
186
Unlink a child key from a parent key
187
187
188
-
Unlinks a single child key from a given parentkey.
188
+
Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.
**200** | The child key was successfully unlinked from the parent key. The response body is empty. | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
259
259
**400** | Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
260
260
**401** | Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. | - |
261
261
**403** | Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions. | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
* @param _callback Callback for upload/download progress
387
387
* @return Call to execute
388
388
* @throws ApiException If fail to serialize the request body object
389
389
* @http.response.details
390
390
<table summary="Response Details" border="1">
391
391
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
392
-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
392
+
<tr><td> 200 </td><td> The child key was successfully unlinked from the parent key. The response body is empty. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
393
393
<tr><td> 400 </td><td> Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
394
394
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
395
395
<tr><td> 403 </td><td> Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
* Unlinks a single child key from a given parentkey.
463
+
* Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.
464
464
* @param projectId Project ID (required)
465
465
* @param id Parent Translation Key ID (required)
466
-
* @param childKeyId The ID of the child key to unlink. (required)
466
+
* @param childKeyId The ID of the child translation key to unlink from the parent. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
469
469
* @http.response.details
470
470
<table summary="Response Details" border="1">
471
471
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
472
-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
472
+
<tr><td> 200 </td><td> The child key was successfully unlinked from the parent key. The response body is empty. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
473
473
<tr><td> 400 </td><td> Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
474
474
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
475
475
<tr><td> 403 </td><td> Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
* Unlinks a single child key from a given parentkey.
487
+
* Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.
488
488
* @param projectId Project ID (required)
489
489
* @param id Parent Translation Key ID (required)
490
-
* @param childKeyId The ID of the child key to unlink. (required)
490
+
* @param childKeyId The ID of the child translation key to unlink from the parent. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
494
494
* @http.response.details
495
495
<table summary="Response Details" border="1">
496
496
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
497
-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
497
+
<tr><td> 200 </td><td> The child key was successfully unlinked from the parent key. The response body is empty. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
498
498
<tr><td> 400 </td><td> Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
499
499
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
500
500
<tr><td> 403 </td><td> Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
@@ -510,18 +510,18 @@ public ApiResponse<Void> keyLinksDestroyWithHttpInfo(String projectId, String id
510
510
511
511
/**
512
512
* Unlink a child key from a parent key (asynchronously)
513
-
* Unlinks a single child key from a given parentkey.
513
+
* Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.
514
514
* @param projectId Project ID (required)
515
515
* @param id Parent Translation Key ID (required)
516
-
* @param childKeyId The ID of the child key to unlink. (required)
516
+
* @param childKeyId The ID of the child translation key to unlink from the parent. (required)
* @param _callback The callback to be executed when the API call finishes
519
519
* @return The request call
520
520
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
521
521
* @http.response.details
522
522
<table summary="Response Details" border="1">
523
523
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
524
-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
524
+
<tr><td> 200 </td><td> The child key was successfully unlinked from the parent key. The response body is empty. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
525
525
<tr><td> 400 </td><td> Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
526
526
<tr><td> 401 </td><td> Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry. </td><td> - </td></tr>
527
527
<tr><td> 403 </td><td> Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions. </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
0 commit comments