Skip to main content
PUT
/
public
/
workspace
/
{workspaceId}
/
links
/
{linkId}
Update recording link
curl --request PUT \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "linkTitle": "<string>",
  "linkReusable": true,
  "linkProviderId": "<string>",
  "linkProviderRef": "<string>",
  "linkMeta": {}
}
'
{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "link": {
      "linkId": "<string>",
      "linkTitle": "<string>",
      "linkReusable": true,
      "linkProviderId": "<string>",
      "linkProviderReference": "<string>",
      "linkURL": "<string>",
      "linkMeta": {},
      "createdAt": "<unknown>",
      "project": {
        "projectId": "<string>",
        "title": "<string>"
      },
      "creator": {
        "workspaceMemberId": "<string>",
        "name": "<string>"
      },
      "domain": {
        "domainId": "<string>",
        "url": "<string>"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.userplane.io/llms.txt

Use this file to discover all available pages before exploring further.

Updates the settings of an existing recording link. All body fields are optional — only include the fields you want to change.

​
Errors

Error codeStatusDescription
LINK_NOT_FOUND404Link does not exist
LINK_GONE410Link has been deleted
LINK_UPDATE_FAILED500Failed to update the link
Also returns common authentication errors.

Get Link

Retrieve link details before or after update

Delete Link

Soft-delete a link you no longer need

Create Link

Create a new recording link

List Links

View all links in the workspace

Authorizations

​
Authorization
string
header
required

API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers

Path Parameters

​
workspaceId
string
required
Minimum string length: 1
​
linkId
string
required
Minimum string length: 1

Body

application/json
​
linkTitle
string | null
Maximum string length: 255
​
linkReusable
boolean
​
linkProviderType
enum<string>
Available options:
intercom,
zendesk,
hubspot,
freshdesk,
freshchat,
jira_service_management,
helpscout,
happyfox,
ada,
forethought,
servicenow,
front,
zoho_desk,
crisp,
pylon,
plain,
asana,
azure_devops,
clickup,
github,
gitlab,
jira,
linear,
notion,
sentry,
slack,
web,
others
​
linkProviderId
string | null
Maximum string length: 255
​
linkProviderRef
string | null
Maximum string length: 2048
​
linkMeta
object

Response

OK

​
message
string
required
​
data
object
required