---
title: "Update"
method: PATCH
path: "/v1/payment_links/{id}"
tags: ["Payment Links"]
---

# Update

`PATCH /v1/payment_links/{id}`

This endpoint allows you to update the details of a specific payment link.

### Body Parameters

| Key | Required | Type | Description |
| --- | --- | --- | --- |
| name | false | string (max: 250) | The name of the payment link. |
| description | false | string (max: 250) | A description of the payment link. |
| slug | false | string (max: 250) | A unique identifier (URL-friendly). Must match regex: `^[a-zA-Z0-9-]+$`. |
| amount | false | string | The amount for the payment link. Must be a valid string number > 0. |
| redirectUrl | false | string (URL) | The URL to redirect the user after payment. Must include `http://` or `https://`. |
| successMessage | false | string (max: 500) | Message shown when the payment succeeds. |
| active | false | boolean | Indicates whether the payment link is active. |
| inactiveMessage | false | string (max: 500) | Message shown when the payment link is inactive. |
| metadata | false | object (JSON string) | Custom metadata as key-value pairs (`string` or `number`). Must be sent as a JSON string in form-data. |
| paymentLimit | false | number (min: 1) | Maximum number of payments allowed for this link. |
| file | false | file | An optional file upload (e.g., image or document) attached to the payment link. |

## Response `200`

200

- object
  - `data` object
    - `active` boolean
    - `amount` string
    - `configurations` object
    - `createdAt` string
    - `created_channel` string
    - `currency` string
    - `description` string
    - `id` string
    - `imageUrl` unknown
    - `inactiveMessage` unknown
    - `metadata` object
    - `name` string
    - `network` string
    - `redirectUrl` string
    - `slug` string
    - `successMessage` unknown
    - `type` string
    - `updatedAt` string
  - `message` string
  - `statusCode` number

---

[API](https://skmtc.net/blockradar/apis/blockradar-documentation.md) · [All operations](https://skmtc.net/blockradar/apis/blockradar-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blockradar/blockradar-documentation/revisions/97f95b4cfc0d/schema)