POST invitations/{partnerConfigurationID}

Request Information

URI Parameters

Name	Description	Type	Additional information
partnerConfigurationID		string	Required

Body Parameters

IntegrationInvitation

Name	Type	Additional information
RespondentID	integer	None.
RespondentFamilyName	string	None.
RespondentFirstName	string	None.
RespondentGender	string	None.
RespondentEmailAddress	string	None.
QuestionnaireID	string	None.
LanguageID	string	None.
ExternalID	string	None.
Custom1	string	None.
Custom2	string	None.
ExpiryDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "respondentID": 1,
  "respondentFamilyName": "sample string 1",
  "respondentFirstName": "sample string 2",
  "respondentGender": "sample string 3",
  "respondentEmailAddress": "sample string 4",
  "questionnaireID": "sample string 5",
  "languageID": "sample string 6",
  "externalID": "sample string 7",
  "custom1": "sample string 8",
  "custom2": "sample string 9",
  "expiryDate": "2025-08-29T22:38:48.6136122+00:00"
}

text/html

Sample:

{"respondentID":1,"respondentFamilyName":"sample string 1","respondentFirstName":"sample string 2","respondentGender":"sample string 3","respondentEmailAddress":"sample string 4","questionnaireID":"sample string 5","languageID":"sample string 6","externalID":"sample string 7","custom1":"sample string 8","custom2":"sample string 9","expiryDate":"2025-08-29T22:38:48.6136122+00:00"}

application/xml, text/xml

Sample:

<IntegrationInvitation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GenesysOnline.Web.RestApi.Models">
  <Custom1>sample string 8</Custom1>
  <Custom2>sample string 9</Custom2>
  <ExpiryDate>2025-08-29T22:38:48.6136122+00:00</ExpiryDate>
  <ExternalID>sample string 7</ExternalID>
  <LanguageID>sample string 6</LanguageID>
  <QuestionnaireID>sample string 5</QuestionnaireID>
  <RespondentEmailAddress>sample string 4</RespondentEmailAddress>
  <RespondentFamilyName>sample string 1</RespondentFamilyName>
  <RespondentFirstName>sample string 2</RespondentFirstName>
  <RespondentGender>sample string 3</RespondentGender>
  <RespondentID>1</RespondentID>
</IntegrationInvitation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IntegrationInvitation'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.