Update a reward

Edit the data of an existing reward. All new granted rewards will inherit of the updated data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error cases

Reward external_id does not exist (404)

{
    "status": 404,
    "errors": [
        {
            "error_key": "id",
            "error": "wrong_value",
            "error_description": "Record not found for id my_test_reward."
        }
    ]
}

Malformatted value - ex: boolean as string (400)

Generic error for all fields and custom fields values types

{
    "status": 400,
    "errors": [
        {
            "error_key": "name",
            "error": "wrong_type",
            "error_description": "This value should be of type string."
        }
    ]
}
{
    "error_key": "",
    "error": "wrong_field_type",
    "error_description": "something went wrong"
}

Edit non-existing or non-editable field (400)

Wording will mention field does not exist for the PATCH method

{
    "status": 400,
    "errors": [
        {
            "error_key": "external_id",
            "error": "unknown_field",
            "error_description": "The field \"external_id\" does not exist."
        }
    ]
}
Path Params
string
required

Reward external identifier.

Body Params

Edit a reward.

string
length ≤ 128
string
string
string
string
boolean
string
string
integer
integer
boolean
string
number
integer
integer
string
custom_fields
array of objects
custom_fields
Responses

401

Authentication failed.

403

Forbidden.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json