promotion.remove

This method is used to remove a Promotion

Version

v1

Arguments

This method has the path /payment/v1/promotion.remove and follows the MicroBase API calling conventions.

Argument Required Type Example Description
id no String iw3RA1EE The id of the Promotion to remove.

Response

Returns a default response:

{
    "ok": true
}

Errors

Expected errors that this method could return. Some errors return additional data.

Error Data Description
promotion_not_found The id not found The Promotion was not found

Example

curl --request POST \
  --url 'http://localhost:3000/services/promotion/v1/promotion.remove?id=ia5RA1W9 \
  --header 'authorization: Bearer xxxxx...' \
  --header 'accept: application/json' \
  --header 'content-type: application/json'