---
updatedAt: 2026-06-09T16:19:20.000Z
agentTools:
  projectIndex: https://docs.smartsurvey.io/llms.txt
---

# Insert

Inserts a new tracking link of the given type with an optional title

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "SS Public API",
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://{host}/v2",
      "description": "Select the host for the region your account's data is stored in.",
      "variables": {
        "host": {
          "default": "api.smartsurvey.io",
          "description": "The regional hostname for your account.",
          "enum": [
            "api.smartsurvey.io",
            "api-eu.smartsurvey.io",
            "api-us.smartsurvey.io"
          ]
        }
      }
    }
  ],
  "paths": {
    "/surveys/{surveyId}/links": {
      "post": {
        "tags": [
          "SurveyTrackingLinks"
        ],
        "summary": "Insert",
        "description": "Inserts a new tracking link of the given type with an optional title",
        "parameters": [
          {
            "name": "surveyId",
            "in": "path",
            "description": "The survey id where you want to insert the new tracking link",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorInsertRequest"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorInsertRequest"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorInsertRequest"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorInsertRequest"
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorInsertRequest"
              }
            },
            "application/*+xml": {
              "schema": {
                "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorInsertRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorDetailedResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorDetailedResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorDetailedResponse"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorDetailedResponse"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorDetailedResponse"
                }
              }
            }
          },
          "400": {
            "description": "Request validation errors",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Survey not found",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Microsoft.AspNetCore.Mvc.ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when\r\ndereferenced, it provide human-readable documentation for the problem type\r\n(e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be\r\n\"about:blank\".",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence\r\nof the problem, except for purposes of localization(e.g., using proactive content negotiation;\r\nsee[RFC7231], Section 3.4).",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem.",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "nullable": true
          }
        },
        "additionalProperties": {},
        "description": "A machine-readable format for specifying errors in HTTP API responses based on <see href=\"https://tools.ietf.org/html/rfc7807\" />."
      },
      "Microsoft.AspNetCore.Mvc.ValidationProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when\r\ndereferenced, it provide human-readable documentation for the problem type\r\n(e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be\r\n\"about:blank\".",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence\r\nof the problem, except for purposes of localization(e.g., using proactive content negotiation;\r\nsee[RFC7231], Section 3.4).",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem.",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "nullable": true
          },
          "errors": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "nullable": true
          }
        },
        "additionalProperties": {}
      },
      "SmartSurvey.Public.API.Models.SurveyCollectors.LinkSettings": {
        "type": "object",
        "properties": {
          "translation_id": {
            "type": "integer",
            "description": "The translation id for this tracking link or 0 if using the default translation",
            "format": "int32"
          },
          "ssl": {
            "type": "boolean",
            "description": "The ssl status for the tracking link"
          },
          "anonymous": {
            "type": "boolean",
            "description": "Whether this tracking link is anonymous i.e. doesn't store respondents details"
          },
          "multiple_responses": {
            "type": "boolean",
            "description": "Whether multiple responses are permitted using the same link/respondent"
          },
          "redirect_url": {
            "type": "string",
            "description": "A redirect uri used when the survey is finished",
            "nullable": true
          },
          "redirect_timer": {
            "type": "integer",
            "description": "A number of minutes permitted to fill in the survey before the response is closed, or 0 if not used",
            "format": "int32"
          },
          "disqualify_redirect_url": {
            "type": "string",
            "description": "A redirect uri used if the respondent is disqualified by skip logic",
            "nullable": true
          },
          "disqualify_redirect_timer": {
            "type": "integer",
            "description": "The number of seconds that the response will wait before redirecting a disqualified respondent",
            "format": "int32"
          },
          "maximum_quota": {
            "type": "integer",
            "description": "A maximum number of responses permitted before the tracking link is closed or 0 if not used",
            "format": "int32"
          },
          "require_password": {
            "type": "string",
            "description": "Whether this tracking link is password protected. Returns \"true\" or \"false\"",
            "nullable": true
          },
          "auto_close": {
            "type": "boolean",
            "description": "Whether this tracking link automatically closes at a certain date/time"
          },
          "auto_close_date": {
            "type": "string",
            "description": "If set, the date and time that this tracking link will automatically close",
            "format": "date-time",
            "nullable": true
          },
          "email_notification": {
            "type": "boolean",
            "description": "Whether this tracking link fires an email notification when a response is completed"
          }
        },
        "additionalProperties": false,
        "description": "Container for various settings on tracking links"
      },
      "SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorDetailedResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique id for the tracking link",
            "format": "int32"
          },
          "type": {
            "type": "string",
            "description": "The type of tracking link. Possible values: web_link, email_invitation, offline, consumer_panel, web_embed, web_popup, facebook, qr_code",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "The title of the tracking link",
            "nullable": true
          },
          "status": {
            "type": "string",
            "description": "The status of the tracking link e.g. \"open\" or \"closed\"",
            "nullable": true
          },
          "responses": {
            "type": "integer",
            "description": "The number of responses that this tracking link has",
            "format": "int32"
          },
          "date_created": {
            "type": "string",
            "description": "The date that this tracking link was created",
            "format": "date-time"
          },
          "date_modified": {
            "type": "string",
            "description": "The date that this tracking link was last modified, which will equal date_created if not modified",
            "format": "date-time"
          },
          "date_closed": {
            "type": "string",
            "description": "If closed, the date the tracking link was closed",
            "format": "date-time",
            "nullable": true
          },
          "survey_url": {
            "type": "string",
            "description": "The survey link for this tracking link",
            "nullable": true
          },
          "href": {
            "type": "string",
            "description": "An API link for this specific tracking link",
            "nullable": true
          },
          "properties": {
            "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.SurveyCollectors.LinkSettings"
          }
        },
        "additionalProperties": false,
        "description": "A more detailed response used when querying individual tracking links"
      },
      "SmartSurvey.Public.API.Models.SurveyCollectors.SurveyCollectorInsertRequest": {
        "type": "object",
        "properties": {
          "title": {
            "maxLength": 100,
            "type": "string",
            "description": "An optional title for the tracking link",
            "nullable": true
          },
          "type": {
            "type": "integer",
            "description": "The type of tracking link to create",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "A request object for adding survey tracking links"
      }
    },
    "securitySchemes": {
      "Basic": {
        "type": "http",
        "description": "Basic Authorization",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "Basic": []
    }
  ]
}
```