PATCH: /kudoz/:k_id/translations/:t_id

Required authorization scope

When using OAuth2 access tokens, the kudoz.write or kudoz.all scope is required to update a KudoZ translation. See scopes in the authentication guide for information about how to request this scope of authorization.

Parameters

Send a partial JSON representation of the KudoZ translation in the request body, with just the fields you want to update. Any non-editable fields will be ignored.

Selecting the "best" translation

To select a KudoZ translation (i.e. mark it as the "best"), send the following in the request body.

{
    "selected": true,
    "selection_comment": "Thanks!",
    "points_awarded": 4,
    "glossary_entry": {
        "source_term": "over-proportionality in systemic exposure",
        "target_term": "over-proportionnalité de l'exposition systémique"
    }
}

glossary_entry is optional. If set, it should specify a glossary entry to create for this term, which will become the glossary_entry for the parent KudoZ record. The source term and target term can be different than the actual KudoZ record and selected translation; they can optionally be "cleaned up" to make them more suitable for the glossary.

Adding a note to a translation

Users can add note to translations they suggested. To add a note to a translation, send the following in the request body.

{
    "addendum": "Some additional information that will be appended to the explanation."
}

The addendum will be appended to the translation's explanation field, along with a timestamp.

Hiding a translation

Users can hide translations that they suggested. To hide a translation, send the following in the request body.

{
    "hidden": true,
    "hide_reason": "Posted by mistake."
}

Example request

Here's an example of a request using curl:

curl --request PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer OAUTH2_ACCESS_TOKEN' \
    -d '{
          "selected": true,
          "selection_comment": "Thanks!",
          "points_awarded": 4
        }' \
    https://api.proz.com/v2/kudoz/123/translations/3467

Response

On success, a 200 OK HTTP status code will be returned, along with the current full KudoZ translation.

On error, a standard error response will be returned.

If a request fails because access is denied, a 403 Unauthorized HTTP status code will be returned, along with an error string explaining the reason.