Benefits
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.
The tier segment ID.
Your private Inveterate API key.
GET /v2.0/admin/tiers/{id}/benefits HTTP/1.1
Host:
X-Inveterate-Api-Key: text
Accept: */*
{
"message": "text",
"data": {}
}
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.
The tier segment ID.
The benefit type.
Your private Inveterate API key.
GET /v2.0/admin/tiers/{id}/benefits/{type} HTTP/1.1
Host:
X-Inveterate-Api-Key: text
Accept: */*
{
"message": "text",
"data": {}
}
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.
The tier segment ID.
The benefit identification name/type.
Your private Inveterate API key.
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": {}
}
Was this helpful?