Skip to content
Responsly API Docs

Create unique survey links

POST

https://api.responsly.com/v1/distributions/create_unique_links

Body parameters

  • form_id (string, required): Survey ID
  • contact_list_id (string, optional): ID of Contact Lists
  • expires_at (string, optional): Expiry time of link in UTC (format: YYYY-MM-DDTHH:MM:SSZ )
  • type (string, optional): Type of link, specifies if the link is one-time or anonymous. Allowed values: “one_time”, “anonymous”.

Request

cURL

Terminal window
curl --request POST \
 --url 'https://api.responsly.com/v1/distributions/create_unique_links' \
 --header 'Authorization: Bearer <Access Token>' \
 --header 'Content-Type: application/json' \
 --data '{
     "form_id": "YOUR_FORM_ID",
     "contact_list_id": "YOUR_CONTACT_LIST_ID",
     "expires_at": "2024-07-31T17:03:00Z",
     "type": "one_time"
 }'

Response

{
    "items": [
        {
            "contact_id": "Ge8pKZ42P3dLwsg5xoJzg0YRjBsafzryEO1kJ",
            "link": "http://form.responsly.com/f/ojNEL7gX?token=yvOgZA5VkWDoGlmasQ68lENL8emK67w413",
            "expires_at": "2024-07-31T17:03:00.000000Z",
            "type": "one_time",
            "name": "Contact Name",
            "email": "example@example.com"
        }
    ]
}

Status Code: 201 Created