Update Link

Update recording link settings

PUT /public/workspace/{workspaceId}/links/{linkId}

Update recording link

cURL

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": {}
}
'

import requests

url = "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}"

payload = {
    "linkTitle": "<string>",
    "linkReusable": True,
    "linkProviderId": "<string>",
    "linkProviderRef": "<string>",
    "linkMeta": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    linkTitle: '<string>',
    linkReusable: true,
    linkProviderId: '<string>',
    linkProviderRef: '<string>',
    linkMeta: {}
  })
};

fetch('https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'linkTitle' => '<string>',
    'linkReusable' => true,
    'linkProviderId' => '<string>',
    'linkProviderRef' => '<string>',
    'linkMeta' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}"

	payload := strings.NewReader("{\n  \"linkTitle\": \"<string>\",\n  \"linkReusable\": true,\n  \"linkProviderId\": \"<string>\",\n  \"linkProviderRef\": \"<string>\",\n  \"linkMeta\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"linkTitle\": \"<string>\",\n  \"linkReusable\": true,\n  \"linkProviderId\": \"<string>\",\n  \"linkProviderRef\": \"<string>\",\n  \"linkMeta\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links/{linkId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"linkTitle\": \"<string>\",\n  \"linkReusable\": true,\n  \"linkProviderId\": \"<string>\",\n  \"linkProviderRef\": \"<string>\",\n  \"linkMeta\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "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>"
      }
    }
  }
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Invalid request parameters. Check the request body and query parameters. See https://docs.userplane.io/api/error-handling",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "API key is required. Include it as Authorization: Bearer <your-api-key>. See https://docs.userplane.io/api/authentication",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "The API key is disabled. Enable it or create a new key. See https://docs.userplane.io/api/authentication",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Workspace not found",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Workspace has been deleted",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Rate limit exceeded. Wait and retry with exponential backoff. See https://docs.userplane.io/api/rate-limits",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Failed to update link",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "API key verification service is temporarily unavailable. Please try again later. See https://docs.userplane.io/api/error-handling",
  "data": "<unknown>"
}

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

Errors

Error code	Status	Description
LINK_NOT_FOUND	404	Link does not exist
LINK_GONE	410	Link has been deleted
LINK_UPDATE_FAILED	500	Failed to update the link

Also returns common authentication errors.

Related

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

Show child attributes

Response

200

application/json

OK

message · string · required

data · object · required

Show child attributes