Skip to content

Update a benefit

Request

This endpoint will take a benefit type and any other values in the relevant schema and send a request to our backend to update the benefit with the new information. Keep in mind that, like with the POST method, this is a request against our backend. Thus, the effect will not be immediate.

Security
api_key
Path
typestringrequired

The benefit identification name/type.

Bodyapplication/jsonrequired
One of:
creditAmountnumberrequired

The amount to be awarded upon sign-up.

namestringrequired

The name (appearance only) of this benefit.

daysnumberrequired

The number of days to delay the credit award.

descriptionstringrequired

The description of this benefit (appearance only).

typeobjectrequired

This is an internal identifier, leave default.

Default:"SIGNUP_STORE_CREDITS"
curl -i -X PATCH \
  'https://public.inveterateapi.com/v2.0/admin/benefits/{type}' \
  -H 'Content-Type: application/json' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "creditAmount": 0,
    "name": "string",
    "days": 0,
    "description": "string",
    "type": "SIGNUP_STORE_CREDITS"
  }'

Responses

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

Bodyapplication/json
messagestringrequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectrequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Response
{
  "message": "Request sent successfully",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}