POST /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits

Creates balance limit and sends the created UUID along with the data

Servers

Path parameters

Name Type Required Description
pid String Yes

Loyalty Program Id

bdid String Yes

Balance Definition Id

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
slidingSchedule Boolean No

Determines if the limit resets on a rolling schedule.

transactionType String Yes

Specifies whether the limit applies to credit or debit transactions.

Valid values:

  • "credit"
  • "debit"
durationValue Integer Yes

Number of time units for the balance limit.

constraintType String Yes

Defines whether the limit applies to transaction count or amount.

Valid values:

  • "transaction"
  • "amount"
value Integer Yes

Maximum allowed value for the specified constraint type.

durationUnit String Yes

Unit of time for which the limit is applicable.

Valid values:

  • "month"
  • "day"
  • "week"
  • "year"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.