List Distribution Links
GET {{baseUrl}}/distributions/:distributionId/links?skipToken=<string>&surveyId=SV_cHbKMOdeT8NetF3
Return a list of individual distribution links for an existing distribution.
Email Status Always Shows
Not SentWhile email status is returned by this call, it will always be set to
Email not sent.This call will not show the respondent's progress. This call is strictly meant to return the distribution links created in the Generate Distribution Links call. Running this call on other distributions will reset email status dates to the date the API is run. If you want to get the respondent's progress, use the contactId returned in the result and call Get Contact History. Additional contact information is located in the List Contacts API result. <!-- theme: warning -->Calling this API will result in the Contact Frequency Rules for a contact to be updated.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
skipToken | string | ||
surveyId | string | (Required) The ID of the survey to which the distribution belongs. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"contactId":"CGC_012345678901234","link":"https://WCIPRtMAE.jkbqNtT1lgv3HvRvKOeOULcwzoGOSMCEYyxOHBo2Psh","linkExpiration":"1987-09-06T11:11:11.718Z","lastName":"eu dolore deserunt Excepteur","firstName":"dolor in","externalDataReference":"exercitat","email":"id","unsubscribed":true,"status":"sunt","exceededContactFrequency":true},{"contactId":"CGC_012345678901234","link":"http://VjmvZxkyfuMbKMagTgZPFbomsVIBUAMU.ihc5UR9EkZiPvsRPXOwVDfC,JB7Mf+H-Dp8szP4SvusRaP0Hep5+vb5f,","linkExpiration":"1969-07-27T22:29:12.485Z","lastName":"enim","firstName":"irure nostrud consectetur ad","externalDataReference":"non elit","email":"reprehenderit ipsum cillum consectetur occaecat","unsubscribed":true,"status":"et veniam nostrud Lorem est","exceededContactFrequency":true}],"nextPage":"sint adipisicing Excepteur"},"meta":{"httpStatus":"laborum labore minim","requestId":"Ut ipsum nostrud","notice":"in esse cupidatat Ut"}}