# Update a coupon

To [update](https://docs.commercelayer.io/core/updating-resources) an existing coupon, send a `PATCH` request to the `/api/coupons/:id` endpoint, where `id` is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

## Request

**PATCH** <https://yourdomain.commercelayer.io/api/coupons/:id>

### Arguments

| Body Parameter                       | Type       | Required |
| ------------------------------------ | ---------- | -------- |
| **type**                             | `string`   | Required |
| **id**                               | `string`   | Required |
| attributes.**code**                  | `string`   | Optional |
| attributes.**customer\_single\_use** | `boolean`  | Optional |
| attributes.**usage\_limit**          | `integer`  | Optional |
| attributes.**recipient\_email**      | `string`   | Optional |
| attributes.**expires\_at**           | `datetime` | Optional |
| attributes.**\_add\_tags**           | `string`   | Optional |
| attributes.**\_remove\_tags**        | `string`   | Optional |
| attributes.**reference**             | `string`   | Optional |
| attributes.**reference\_origin**     | `string`   | Optional |
| attributes.**metadata**              | `object`   | Optional |
| relationships.**promotion\_rule**    | `object`   | Optional |
| relationships.**coupon\_recipient**  | `object`   | Optional |
| relationships.**tags**               | `array`    | Optional |

### Example

{% tabs %}
{% tab title="Request" %}
The following request updates the coupon identified by the ID "XAyRWNUzyN":

```shell
curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "coupons",
    "id": "xYZkjABcde",
    "attributes": {
      "usage_limit": 50
    },
    "relationships": {
      "promotion_rule": {
        "data": {
          "type": "promotion_rules",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'
```

{% endtab %}

{% tab title="Response" %}
On success, the API responds with a `200 OK` status code, returning the updated resource object:

```json
{
  "data": {
    "id": "XAyRWNUzyN",
    "type": "coupons",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN"
    },
    "attributes": {
      "code": "04371af2-70b3-48d7-8f4e-316b374224c3",
      "customer_single_use": false,
      "usage_limit": 50,
      "usage_count": 20,
      "recipient_email": "john@example.com",
      "expires_at": "2018-01-01T12:00:00.000Z",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "promotion_rule": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/relationships/promotion_rule",
          "related": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/promotion_rule"
        }
      },
      "coupon_recipient": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/relationships/coupon_recipient",
          "related": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/coupon_recipient"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/events"
        }
      },
      "tags": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/relationships/tags",
          "related": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/tags"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/versions"
        }
      },
      "event_stores": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/relationships/event_stores",
          "related": "https://yourdomain.commercelayer.io/api/coupons/XAyRWNUzyN/event_stores"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}
```

{% endtab %}
{% endtabs %}