Discount groups

Update a discount group

Changed on

Updates a discount group using its ID.

If successful, your response includes a copy of the updated discount group entity.

patch/discount-groups/{discount_group_id}

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

discount_group_idstring required

Paddle ID of the discount group entity to work with.

Request body

status'active' | 'archived'

Whether this entity can be used in Paddle.

namestring

Name of this discount group, typically something short and memorable for categorization. Not shown to customers.

Response

The request has succeeded.

Example response

{
  "data": {
    "id": "dsg_01js2gqehzccfkywgx1jk2mtsp",
    "created_at": "2024-10-12T07:20:50.52Z",
    "updated_at": "2024-10-13T07:20:50.52Z",
    "import_meta": {
      "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
      "imported_from": "paddle_classic"
    }
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes