Skip to content
Mews Open API

Add loyalty tiers

POST
/api/connector/v1/loyaltyTiers/add

Adds loyalty tiers to a loyalty program of the enterprise chain. Note this operation supports Portfolio Access Tokens.

Request Body

Section titled “Request Body ”
MultipleLoyaltyTierAddParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
ChainId

Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.

string format: uuid
nullable
LoyaltyTiers
required

Loyalty tiers to be added.

Array<object>
>= 1 items <= 1000 items
Loyalty tier add parameters
object
LoyaltyProgramId
required

Unique identifier of the loyalty program the tier belongs to.

string format: uuid
Name
required

Name of the loyalty tier.

string
>= 1 characters <= 50 characters
Code
required

Code of the loyalty tier.

string
>= 1 characters <= 50 characters
Ordering
required

Ordering of the loyalty tier.

integer format: int32
Example
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "LoyaltyTiers": [
    {
      "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5",
      "Name": "Platinum",
      "Code": "P1",
      "Ordering": 1
    }
  ],
  "ChainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

LoyaltyTierWriteResult
object
LoyaltyTiers
required

The loyalty tiers of the loyalty program within the chain.

Array<object>
<= 1000 items
Loyalty tier
object
Id
required

Unique identifier of the loyalty tier.

string format: uuid
LoyaltyProgramId
required

Unique identifier of the loyalty program of that loyalty tier.

string format: uuid
Name
required

Name of the loyalty tier.

string
>= 1 characters <= 50 characters
Code
required

Code of the loyalty tier.

string
>= 1 characters <= 50 characters
Ordering
required

Ordering of the loyalty tier.

integer format: int32
Example
{
  "LoyaltyTiers": [
    {
      "Id": "69eedfd2-6f25-42fc-b3c8-39df70f85e37",
      "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5",
      "Name": "Platinum",
      "Code": "P1",
      "Ordering": 1
    }
  ]
}

204

Section titled “204 ”

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

400

Section titled “400 ”

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

401

Section titled “401 ”

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

403

Section titled “403 ”

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

408

Section titled “408 ”

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

429

Section titled “429 ”

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

500

Section titled “500 ”

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable