POST: /kudoz

Required authorization scope

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

Parameters

Pass the JSON representation of the KudoZ record as the POST data.

Any read-only attributes you set will be ignored.

Example request

Here's an example of submitting a request using curl:

curl -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer OAUTH2_ACCESS_TOKEN' \
    -d '{
          "source_term": "over-proportionality in systemic exposure",
          "language_pair": "eng_fra",
          "level": "pro",
          "preferred_language": "eng",
          "disc_gen_id": 3,
          "disc_spec_id": 95,
          "disc_write_in": "étude clinique/anticance",
          "context": "Doses should not be doubled because with daily doses over the 2.5 mg recommended dose, over-proportionality in systemic exposure was observed (see section Pharmacokinetics).",
          "no_points": false,
          "may_offend": false,
          "from_test": false,
          "from_non_pro": false,
          "auto_close": false,
          "translator_requirements": {
            "native_language": null,
            "language_pair": null,
            "disc_level": null,
            "members_only": null
          }
        }' \
    https://api.proz.com/v2/kudoz

Response

On success, a 201 Created HTTP status code will be returned, along with the created KudoZ record.

On error, a standard error response will be returned.

If a request fails because limits were exceeded, a 429 Too Many Requests HTTP status code will be returned, along with an error string explaining the reason. 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.