Benefits

get

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.

Path parameters

idstringRequired

The tier segment ID.

Header parameters

X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Responses

200

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

application/json

400

Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.

application/json

500

Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.

application/json

get

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

HTTPcURLJavaScriptPython

GET /v2.0/admin/tiers/{id}/benefits HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*

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

get

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.

Path parameters

idstringRequired

The tier segment ID.

typestringRequired

The benefit type.

Header parameters

X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Responses

200

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

application/json

400

Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.

application/json

500

Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.

application/json

get

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

HTTPcURLJavaScriptPython

GET /v2.0/admin/tiers/{id}/benefits/{type} HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*

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

patch

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.

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

application/json

one ofOptional

or

or

or

or

or

or

or

or

or

Responses

201

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.

application/json

400

Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.

application/json

500

Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /v2.0/admin/tiers/{id}/benefits/{type} HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "creditAmount": 1,
  "name": "text",
  "days": 1,
  "description": "text",
  "type": "SIGNUP_STORE_CREDITS"
}

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