Update Spend Rule

patch

https://api.dev.givecard.dev/api/v1/spendRules/{spendRuleId}/

Updates a spend rule. The type can only be changed from merchant_allow to merchant_block or vice versa, type cannot be changed between velocity and merchant rules. To apply or un-apply the rule to all cards within a business or program, set the ApplyTo field.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

spendRuleId

string

required

Body Params

applyTo

string

enum

Allowed:

description

string

displayDescription

string

Optional cardholder-facing supporting text. Same semantics as displayName. Max 500 chars.

displayName

string

Optional cardholder-facing short label. Omit to leave existing value alone; pass "" to clear. Max 80 chars.

name

string

programId

string

Program ID is only required if you plan to change the applyTo field to program

restrictionsToAdd

array of objects

restrictionsToAdd

restrictionsToRemove

array of objects

restrictionsToRemove

type

string

enum

Allowed:

velocityCycle

string

enum

Velocity cycle is required for velocity rules only
all_time VelocityCycleAllTime All-time window; does not reset
monthly VelocityCycleMonthly Resets monthly at 12:00am PT on the first of the month
weekly VelocityCycleWeekly Resets weekly at 12:00am PT on Monday
daily VelocityCycleDaily Resets daily at 12:00am PT
hourly VelocityCycleHourly Hourly is a rolling 60-minute window (not tied to the wall clock hour)
single_transaction VelocityCycleSingleTransaction Applies to a single authorization only (no accumulation)

Allowed:

velocityType

string

enum

Velocity type defaults to 'currency_amount' if not provided
currency_amount VelocityTypeCurrencyAmount Velocity type defaults to 'currency_amount' if not provided
authorization_count VelocityTypeAuthorizationCount

Allowed:

velocityValue

string

Headers

Idempotency-Key

string

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200

400

404

500