Skip to main content

Provision a survey

Provisioning creates or updates Ramon’s mapping for an external LimeSurvey survey. It returns the public values needed to configure the browser embed.

curl --request PUT \
  "https://api.getramon.com/integrations/v1/limesurvey/instances/018f5c80-32e1-7d7a-8c72-4af06fb65a21/surveys/123456" \
  --header "Authorization: Bearer YOUR_INTEGRATION_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Customer experience survey",
    "pluginVersion": "0.2.0",
    "limeSurveyVersion": "7.0.5"
  }'

instanceId is a UUID stable for the LimeSurvey installation. externalSurveyId is the numeric LimeSurvey survey ID. The request body requires non-empty name, pluginVersion, and limeSurveyVersion values.

Response and idempotency​

{
  "data": {
    "surveyId": "65c000000000000000000001",
    "trackingKey": "65c000000000000000000001",
    "collectorApiUrl": "https://api.getramon.com",
    "embedScriptUrl": "https://embed.getramon.com/ramon.js"
  }
}

Repeated calls for the same organization, instance, and external survey reuse the same surveyId. A changed name, plugin version, or LimeSurvey version updates the mapping. Store surveyId with your integration settings and use the returned public values in the browser embed.