DeleteCoupon

post

https://{yourlidiaurl}/marketing/coupons/delete

Deactivates and removes a coupon from the active system, preventing future redemptions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The input command payload containing target properties.

couponId

string

^-?(?:0|[1-9]\d*)$

name

string | null

promotionId

string

^-?(?:0|[1-9]\d*)$

discountAmount

string

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

discountType

string

enum

Allowed values: Flat (10), Percentage (20).

Allowed:

type

string

enum

Allowed values: Voucher (10), Coupon (20).

Allowed:

maxUsage

string

^-?(?:0|[1-9]\d*)$

validFrom

string | null

validThru

string | null

extra

string | null

description

string | null

useCount

string

^-?(?:0|[1-9]\d*)$

couponGroupKey

string | null

couponGroupValue

string | null

restrictions

object

configuration

object

token

string | null

environment

string | null

applicationIP

string | null

userToken

string | null

sessionId

string | null

userId

string

^-?(?:0|[1-9]\d*)$

userIP

string | null

threadId

string | null

status

string

enum

Allowed values: Draft (0), Active (1), Unknown (-999), Deleted (-99), Blocked (-12), Freezed (-11), Test (-9), Passive (-1).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

text/plain

application/json

text/json

200An IActionResult indicating the operation outcome.