PUT v1/Surveys/{surveyId}/InvitationTemplates/{templateId}

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

Permissions required to make this request: SurveyEmailInvitationTemplate.Write SurveyEmailInvitationTemplate.Read Survey.Read

Has survey type usage restrictions online

Update an invitation template.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId		string	Required
templateId		integer	Required

Body Parameters

InvitationTemplateModelUpdate

Name	Description	Type	Additional information
InvitationType	Invitation type. 1 = Invitation. 2 = Reminder.	integer	None.
Name	Name of the invitation template	string	Max length: 150
Subject	Subject of the invitation	string	Max length: 150
Body	Body of the invitation	string	Max length: 2147483647

Request Formats

application/json, text/json

Sample:

{
  "InvitationType": 1,
  "Name": "sample string 2",
  "Subject": "sample string 3",
  "Body": "sample string 4"
}

application/xml, text/xml

Sample:

<InvitationTemplateModelUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Body>sample string 4</Body>
  <InvitationType>1</InvitationType>
  <Name>sample string 2</Name>
  <Subject>sample string 3</Subject>
</InvitationTemplateModelUpdate>

application/x-www-form-urlencoded

Sample:

InvitationType=1&Name=sample&Subject=sample&Body=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

InvitationTemplateModelValidated

Name	Description	Type	Additional information
IsValid	Whether the template is valid	boolean	None.
ValidationError	The validation error in case the template is invalid	string	None.
Id	Invitation template id	integer	None.
InvitationType	Invitation type. 1 = Invitation. 2 = Reminder.	integer	None.
Name	Name of the invitation template	string	Max length: 150
Subject	Subject of the invitation	string	Max length: 150
Body	Body of the invitation	string	Max length: 2147483647

Response Formats

application/json, text/json

Sample:

{
  "IsValid": true,
  "ValidationError": "sample string 2",
  "Id": 3,
  "InvitationType": 4,
  "Name": "sample string 5",
  "Subject": "sample string 6",
  "Body": "sample string 7"
}

application/xml, text/xml

Sample:

<InvitationTemplateModelValidated xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Body>sample string 7</Body>
  <InvitationType>4</InvitationType>
  <Name>sample string 5</Name>
  <Subject>sample string 6</Subject>
  <Id>3</Id>
</InvitationTemplateModelValidated>