Validate a promocode / promo-action code
Header Parameters
Api-Keystring
Query Parameters
codestring Required
Promocode or promo-action code to validate.
ticket_idinteger Required
Catalog membership ID the code is being applied to.
Path Parameters
client_idinteger Required
Response
200
Object
Validation result (crud envelope). Note: data is the single
promo-action object (not an array), or null when the code is
invalid — success stays true either way.
Response Attributes
successboolean
dataallof
A promo-action (discount campaign). Returned by the promocode check
endpoint as the raw record; its id / code can be applied when
selling a membership.
Nullable:
True
Show child attributes
errorstring
error_codeinteger
totalinteger
Nullable:
True
summaryobject
401
Object
Session not established / invalid key.
Response Attributes
successboolean
dataarray
errorstring
session_expiredboolean
totalinteger
Was this section helpful?
Response
Was this section helpful?