POST v1/Surveys/{surveyId}/InviteRespondents

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser LimitedUser SampleManager

Permissions required to make this request: EmailBatch.Send EmailBatch.Read SampleRecord.Read Survey.Read

Has survey type usage restrictions online

Posts a request to create a batch for sending out invitations.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	id of the survey	string	Required

Body Parameters

invitation batch parameters

InvitationBatch

Name	Description	Type	Additional information
Name	Name of the batch	string	Required Max length: 700
EmailColumnName	EmailColumnName contains the email address of the respondent	string	Required Max length: 128
ScheduledFor	Date the invitations are scheduled to be sent out	date	None.
InvitationTemplateId	Id of the invitation template to use for the invitations	integer	None.
Filters	Respondent filters	Collection of SampleFilterModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "EmailColumnName": "sample string 2",
  "ScheduledFor": "2024-05-18T20:40:49.168117+00:00",
  "InvitationTemplateId": 3,
  "Filters": [
    {
      "Name": "sample string 1",
      "Op": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Op": "sample string 2",
      "Value": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<InvitationBatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <EmailColumnName>sample string 2</EmailColumnName>
  <Filters>
    <SampleFilterModel>
      <Name>sample string 1</Name>
      <Op>sample string 2</Op>
      <Value>sample string 3</Value>
    </SampleFilterModel>
    <SampleFilterModel>
      <Name>sample string 1</Name>
      <Op>sample string 2</Op>
      <Value>sample string 3</Value>
    </SampleFilterModel>
  </Filters>
  <InvitationTemplateId>3</InvitationTemplateId>
  <Name>sample string 1</Name>
  <ScheduledFor>2024-05-18T20:40:49.168117+00:00</ScheduledFor>
</InvitationBatch>

application/x-www-form-urlencoded

Sample:

Name=sample&EmailColumnName=sample&ScheduledFor=Nullable`1&InvitationTemplateId=1&Filters=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

batch status

Response Message

InviteRespondentsStatus

Name	Description	Type	Additional information
Count	Number of invited respondents	integer	None.
Status	Status of the batch	string	None.
ErrorMessage	Message detail when indicates an error	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Count": 1,
  "Status": "sample string 2",
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<InviteRespondentsStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Count>1</Count>
  <ErrorMessage>sample string 3</ErrorMessage>
  <Status>sample string 2</Status>
</InviteRespondentsStatus>