Inkress DevelopersPayment links · Update a link
API reference / Payment links
Update a link
PUT/api/v1/payment_links/:idpayment_links:write
Change a link's title, description or expiry. The amount and currency are fixed once it's made. To stop a link taking payments, set expires_at to now.
Path parameters
idintegerrequired
The link's ID.
Body
titlestring
New title.
descriptionstring
New description.
expires_atstring
New closing time, ISO 8601.
usage_limitinteger
New limit.
dataobject
Your own data.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The updated link, with 201.
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |
422 | A field is wrong. |