Create support capture link

POST/workspaces/{organizationId}/support/capture-links

Path parameters

organizationIdstringrequired

Request body

application/json

publicKeyIdstringrequired

min length 1

namestring

min length 1 · default: "Capture link"

expiresAtstring | null

maxSessionsinteger | null

requireChallengeboolean

Responses

201

Capture link created

idstringrequired

organizationIdstringrequired

publicKeyIdstringrequired

tokenstringrequired

namestringrequired

urlstringrequired

expiresAtstring | nullrequired

maxSessionsnumber | nullrequired

requireChallengebooleanrequired

isActivebooleanrequired

createdBystring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

publicKeyIdstring*namestringexpiresAtstringmaxSessionsintegerrequireChallengeboolean

Request

curl -X POST '/workspaces/string/support/capture-links' \
  -H 'Content-Type: application/json' \
  -d '{
  "publicKeyId": "string",
  "name": "Capture link",
  "expiresAt": "string",
  "maxSessions": 1,
  "requireChallenge": true
}'

const response = await fetch("/workspaces/string/support/capture-links", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"publicKeyId\": \"string\",\n  \"name\": \"Capture link\",\n  \"expiresAt\": \"string\",\n  \"maxSessions\": 1,\n  \"requireChallenge\": true\n}"
});

import requests

response = requests.post(
    "/workspaces/string/support/capture-links",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"publicKeyId\": \"string\",\n  \"name\": \"Capture link\",\n  \"expiresAt\": \"string\",\n  \"maxSessions\": 1,\n  \"requireChallenge\": true\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "publicKeyId": "string",
  "token": "string",
  "name": "string",
  "url": "string",
  "expiresAt": "string",
  "maxSessions": 0,
  "requireChallenge": true,
  "isActive": true,
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}