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.

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
X-API-KeystringRequired

API key (UUID)

Path parameters
surveyIdstringRequired

Survey identifier

Header parameters
X-Request-Idstring · uuidOptional

Optional request correlation ID

Body
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.

Responses
chevron-right
200

Link generated

application/json
post
/v1/links/generate/{surveyId}

Last updated