Create unique survey links

POST 
/v3/channels/create_unique_links

Create unique survey links

Request

application/json

Body

survey_id numberrequired

Id of Survey

channel_id numberrequired

Id of Channel

contact_ids number[]

Possible values: <= 100

Id's of Contact

contacts

object[]

Possible values: >= 1, <= 100

Array of contact objects

Array [

full_name string

Possible values: <= 255 characters

Full Name of contact

phone string

Possible values: <= 255 characters

Phone number of the contact

mobile string

Possible values: <= 255 characters

Mobile number of the contact

email string

Possible values: <= 255 characters

Email of contact

job_title string

Possible values: <= 255 characters

Job Title of the contact

contact_type string

Possible values: [contact, employee]

Default value: contact

Type of the contact

variables object

expires_at integer

Possible values: >= 1 and <= 365

]

contact_list_ids number[]

Possible values: <= 100

Id's of Contact Lists

short_url boolean

Create short link for the survey

expiry_type string

Possible values: [absolute, relative]

How every expires_at in the request is read: absolute (a date, the default when not sent) or relative (a number of days after the link is created). A contact's own expires_at overrides the top-level one

expires_at integer

Possible values: >= 1 and <= 365

variables object

Responses

200

Successful

*/*

Schema

Schema

data

object[]

Array [

contact_id numberrequired

ID of the contact

survey_link string

Survey Link

short_url string

Short URL for the survey

variables object

expires_at date

expiry time of link in UTC

]

Example (from schema)

{
  "data": [
    {
      "contact_id": 1,
      "survey_link": "https://example.surveysparrow.com/n/survey-name/unique-identifier",
      "short_url": "short.surveysparrow.com/DHDFYedfh",
      "variables": {},
      "expires_at": "2026-12-21T12:14:19Z"
    }
  ]
}

Loading...