Benefits

Was this helpful?

This endpoint will return all benefits for a merchant under a given tier. It will return an array of benefits. Each benefit will have a type field that will identify the type of benefit.

get

/v2.0/admin/tiers/{id}/benefits

Path parameters

idstringrequired

The tier segment ID.

Header parameters

X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2.0/admin/tiers/{id}/benefits' \
  --header 'X-Inveterate-Api-Key: text'

200

400

500

{
  "message": "text",
  "data": {}
}

Returned upon successful direct action to our database. Action is immediate.

This endpoint will return one specific benefit given a benefit type and segment ID. Note that the benefit type is a string character. For a list of all benefit types, look at the default type value in each schema.

get

/v2.0/admin/tiers/{id}/benefits/{type}

Path parameters

idstringrequired

The tier segment ID.

typestringrequired

The benefit type.

Header parameters

X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2.0/admin/tiers/{id}/benefits/{type}' \
  --header 'X-Inveterate-Api-Key: text'

200

400

500

{
  "message": "text",
  "data": {}
}

Returned upon successful direct action to our database. Action is immediate.

This endpoint will take a benefit type, segment ID, 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.

patch

/v2.0/admin/tiers/{id}/benefits/{type}

Path parameters

idstringrequired

The tier segment ID.

typestringrequired

The benefit identification name/type.

Header parameters

X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v2.0/admin/tiers/{id}/benefits/{type}' \
  --header 'X-Inveterate-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"creditAmount":1,"name":"text","days":1,"description":"text","type":"SIGNUP_STORE_CREDITS"}'

201

400

500

{
  "message": "text",
  "data": {}
}

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.