PATCH
/
v1
/
links
/
{uuid}
/
edit

Authorizations

​
X-API-KEY
string
headerrequired

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Path Parameters

​
uuid
string
required

Body

application/json
​
status
enum<string>
  • enabled - Enabled
  • disabled - Disabled
Available options:
enabled,
disabled
​
title
string

Craft a beautiful name for your link

Maximum length: 50

Response

200 - application/json
​
id
string
required
​
title
string
required
​
url
string
required
​
amount
string
required
​
currency
string
required
​
status
enum<string>
required
  • paid - paid
  • unpaid - unpaid
  • overdue - overdue
  • cancelled - cancelled
  • scheduled - scheduled
Available options:
paid,
unpaid,
overdue,
cancelled,
scheduled
​
discount
string
required
​
allow_tip
boolean
required
​
shipping_address_required
boolean
required
​
items
object[]
required
​
tax
string
required
​
note
string
required
​
taxes
object[]
required
​
discount_percentage
integer
required
​
tip
string
required
​
tip_percentage
integer
required
​
custom_fields
object[]
required
Get LinkDelete Link