POST api/vspinteraction/create
Request Information
URI Parameters
None.
Body Parameters
CreateVspInteraction| Name | Description | 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": "b7ca22c8-50e0-45d1-8f23-2b9561e1a480",
"ContactId": "40a53a5f-c612-4951-af7a-eaf25cd51167",
"TenantKey": "c76f9f27-69f7-47c6-9b84-0e8c164a740e",
"GroupKey": "5033b441-d0e6-4b2f-a9b1-418a180e1b9e"
}
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>b7ca22c8-50e0-45d1-8f23-2b9561e1a480</AccountId> <AppAccessKey>sample string 1</AppAccessKey> <ContactId>40a53a5f-c612-4951-af7a-eaf25cd51167</ContactId> <GroupKey>5033b441-d0e6-4b2f-a9b1-418a180e1b9e</GroupKey> <InteractionIdentity>sample string 2</InteractionIdentity> <InteractionName>sample string 3</InteractionName> <TenantKey>c76f9f27-69f7-47c6-9b84-0e8c164a740e</TenantKey> </CreateVspInteraction>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VspInteraction| Name | Description | 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>