Members

Member accessing and altering endpoints.

Returns all members for a given merchant. Merchant is pulled from the public API key for security reasons.

Pagination is supported by passing limit and lastCustomerId values as
query parameters. You will get a lastCustomerId value in the response
of the previous request, which can be used for the next.

GET/v2.0/admin/members

Query parameters

Header parameters

Response

200400500

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

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurlPython

const response = await fetch('/v2.0/admin/members?limit=text&lastCustomerId=text', {
    method: 'GET',
    headers: {
      "X-Inveterate-Api-Key": "text"
    },
});
const data = await response.json();

Response

200400500

{
  "message": "text"
}

This endpoint is used to create a free tier member. You can also provide a credit value to add credits to the new members account. The overrideSpendThreshold parameter allows you to add customers to a spend based tier, and the keepInSpendBasedTier parameter ensures that the member won't be downgraded if they don't hit the spend minimum. NOTE: This endpoint will downgrade a customer specified to a lower tier if that is the tier provided to the endpoint!

POST/v2.0/admin/members

Header parameters

Body

application/json

customerId*string

The customerId to add to the specified free tier.

referrals*string

The signify whether or not the customer was referred. NOTE: NOT to be used to indicate the referring customer.

segmentId*string

The segmentId of the tier you want to add this customer to.

overrideSpendThreshold*boolean

Whether or not to override the spend required to add a cutomer to a spend based tier.

keepInSpendBasedTier*boolean

Whether or not you want to keep this customer in the spend based tier despite not meeting the spend threshold.

credits*number

Especially for member creation requests, if you would like to add some credits to the specified customer.

Response

201400500

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.

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurlPython

const response = await fetch('/v2.0/admin/members', {
    method: 'POST',
    headers: {
      "X-Inveterate-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerId": "text",
      "referrals": "text",
      "segmentId": "text",
      "overrideSpendThreshold": false,
      "keepInSpendBasedTier": false,
      "credits": 0
    }),
});
const data = await response.json();

Response

201400500

{
  "message": "text"
}

Returns a single member for a given merchant. Merchant is pulled from the public API key for security reasons.

GET/v2.0/admin/members/{id}

Path parameters

id*string

The customer ID number which you would like to retrieve.

Header parameters

Response

200400500

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

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurlPython

const response = await fetch('/v2.0/admin/members/{id}', {
    method: 'GET',
    headers: {
      "X-Inveterate-Api-Key": "text"
    },
});
const data = await response.json();

Response

200400500

{
  "message": "text"
}

This endpoint is used to update a member. It takes a member ID and uses your public API key to match the customer to your account. As of now, all fields in the update schema are required, so it is not possible to update a single field at a time.

PATCH/v2.0/admin/members/{id}

Path parameters

id*string

The customer ID number which you would like to update.

Header parameters

Body

application/json

firstName*string

The customer's first name.

lastName*string

The customer's last name.

notes*string

Internal notes for this customer. Only viewable by the merchant.

phoneNumber*string

The customer's phone number.

Response

201400500

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.

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurlPython

const response = await fetch('/v2.0/admin/members/{id}', {
    method: 'PATCH',
    headers: {
      "X-Inveterate-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "text",
      "lastName": "text",
      "notes": "text",
      "phoneNumber": "text"
    }),
});
const data = await response.json();

Response

201400500

{
  "message": "text"
}