POST api/vspinteraction/create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AppAccessKey	string	Required
InteractionIdentity	string	Required
InteractionName	string	Required
AccountId	globally unique identifier	Required
ContactId	globally unique identifier	Required
TenantKey	globally unique identifier	None.
GroupKey	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "AppAccessKey": "sample string 1",
  "InteractionIdentity": "sample string 2",
  "InteractionName": "sample string 3",
  "AccountId": "89431fff-45e6-47c7-9b66-0785cb2aba2c",
  "ContactId": "9e636a30-d1a1-4ce0-bfc0-f8397e36fafe",
  "TenantKey": "b8f2752f-4b71-4034-82a0-6f7afe8bb362",
  "GroupKey": "bbe43f53-a2f6-4c06-b009-fd9e9fa253f1"
}

application/xml, text/xml

Sample:

<CreateVspInteraction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.Models">
  <AccountId>89431fff-45e6-47c7-9b66-0785cb2aba2c</AccountId>
  <AppAccessKey>sample string 1</AppAccessKey>
  <ContactId>9e636a30-d1a1-4ce0-bfc0-f8397e36fafe</ContactId>
  <GroupKey>bbe43f53-a2f6-4c06-b009-fd9e9fa253f1</GroupKey>
  <InteractionIdentity>sample string 2</InteractionIdentity>
  <InteractionName>sample string 3</InteractionName>
  <TenantKey>b8f2752f-4b71-4034-82a0-6f7afe8bb362</TenantKey>
</CreateVspInteraction>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VspInteraction

Name	Type	Additional information
InteractionId	string	None.
CampaignKey	string	None.
InteractionUrl	string	None.

Response Formats

application/json, text/json

Sample:

{
  "InteractionId": "sample string 1",
  "CampaignKey": "sample string 2",
  "InteractionUrl": "sample string 3"
}

application/xml, text/xml

Sample:

<VspInteraction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.Models">
  <CampaignKey>sample string 2</CampaignKey>
  <InteractionId>sample string 1</InteractionId>
  <InteractionUrl>sample string 3</InteractionUrl>
</VspInteraction>