Sharable Links

Generate shareable survey links

Generate a shareable survey link

post

Generates a dedicated, shareable link for a survey so you can distribute it independently.

Optional built-in fields:

• expiresInMinutes: How long the link should stay active. If omitted, the link has no expiration.

• language: The language to open the survey in. If omitted, the survey is shown in its default language.

• isReusable: Indicates whether the link can be used multiple times. If omitted, the link is single-use.

• title: A user-friendly name for the link, used for display in the UI.

• customFields can contain any fields you want to attach to the generated link (e.g., conversation id, channel, campaign). All custom field values must be strings and are limited to 50 characters.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key (UUID)

Path parameters

surveyIdstringRequired

Survey identifier

Header parameters

X-Request-Idstring · uuidOptional

Optional request correlation ID

Body

application/json

expiresInMinutesinteger · min: 1Optional

How long the link should stay active. If omitted, the link does not expire.

languagestringOptional

Language to open the survey in. If omitted, the survey default language is used.

isReusablebooleanOptional

Indicates whether the generated link can be used multiple times. If omitted, the link is single-use.

titlestringOptional

User-friendly name for the generated link, used for display in the UI.

Responses

201

Link generated successfully. The response body contains the generated shareable link as plain text.

text/plainx-gitbook-description-html

400

Validation error

application/json

401

Invalid or missing API key

application/json

post

/v1/links/generate/{surveyId}

HTTPcURLJavaScriptPython

POST /v1/links/generate/{surveyId} HTTP/1.1
Host: api.pristo.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "expiresInMinutes": 30,
  "isReusable": true,
  "title": "Visit Feedback Link",
  "customFields": {
    "conversationId": "chat_8f3a2c",
    "channel": "chatbot",
    "botProvider": "intercom",
    "campaign": "csat_after_chat"
  }
}

https://stggo.pristo.io/s/abc123456