Definition

POST - 3/surveys/{surveyId}/panelists/{contactId}

Add a panelist to a survey by contactId.

Request information

surveyId

The id of a survey.


Type integer
Additional info
Required
contactId

The id of a contact to be linked to this survey.


Type integer
Additional info
Required

Additional options available when adding a contact.

DateToBeMailed

Date and time on which the invitation will be sent. If not passed, the invitation will be sent once the survey is live or immediately if the survey is already live.


Type date
Additional info
DateToExpire

Date and time on which the invitation should expire and the contact can no longer respond to the survey, if not available the invitation will be active until the survey is closed.


Type date
Additional info
Sample:
{
  "DateToBeMailed": "2019-08-25T06:03:17.74265Z",
  "DateToExpire": "2019-08-25T06:03:17.74265Z"
}
Sample:
<ReusingContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DateToBeMailed>2019-08-25T07:03:17.74265+01:00</DateToBeMailed>
  <DateToExpire>2019-08-25T07:03:17.74265+01:00</DateToExpire>
</ReusingContact>

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas
Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-08-25T06:03:17.7455721Z",
    "IsFiltered": true
  },
  "Data": {
    "Succeeded": true,
    "FailureMessage": "sample string 2",
    "ContactId": 1
  }
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <FailureMessage>sample string 2</FailureMessage>
    <Succeeded>true</Succeeded>
    <ContactId>1</ContactId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-08-25T07:03:17.7455721+01:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>