POST api/v2/interaction/create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientId	string	None.
Secret	string	None.
CampaignIdentity	string	None.
CampaignName	string	None.
CampaignDescription	string	None.
StartDate	string	None.
EndDate	string	None.
VerticalId	string	None.
GroupKey	string	None.
IGroupKey	string	None.
DispositionKeys	string	None.
campaignPreference	CampaignPreference	None.
CampaignTags	Collection of CampaignTags	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": "sample string 1",
  "Secret": "sample string 2",
  "CampaignIdentity": "sample string 3",
  "CampaignName": "sample string 4",
  "CampaignDescription": "sample string 5",
  "StartDate": "sample string 6",
  "EndDate": "sample string 7",
  "VerticalId": "sample string 8",
  "GroupKey": "sample string 9",
  "IGroupKey": "sample string 10",
  "DispositionKeys": "sample string 11",
  "campaignPreference": {
    "BReqCompanyName": true,
    "BReqCustomerName": true,
    "BReqEmail": true,
    "BReqMobile": true,
    "BReqMobileVerify": true,
    "MReqCompanyName": true,
    "MReqCustomerName": true,
    "MReqEmail": true,
    "MReqMobile": true,
    "MReqComment": true,
    "CReqCompanyName": true,
    "CReqCustomerName": true,
    "CReqEmail": true,
    "CReqMobile": true,
    "CReqComment": true,
    "SReqCompanyName": true,
    "SReqCustomerName": true,
    "SReqEmail": true,
    "SReqMobile": true,
    "SReqComment": true,
    "SReqRating": true,
    "CallRecord": true,
    "LogoUrl": "sample string 1",
    "Type": 1,
    "PhoneNumber": "sample string 2",
    "CustomAction": [
      {
        "Type": "sample string 1",
        "Value": "sample string 2",
        "Label": "sample string 3",
        "Visibility": 4
      },
      {
        "Type": "sample string 1",
        "Value": "sample string 2",
        "Label": "sample string 3",
        "Visibility": 4
      }
    ]
  },
  "CampaignTags": [
    {
      "TagName": "sample string 1",
      "TagValue": "sample string 2"
    },
    {
      "TagName": "sample string 1",
      "TagValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<CreateCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.Models">
  <CampaignDescription>sample string 5</CampaignDescription>
  <CampaignIdentity>sample string 3</CampaignIdentity>
  <CampaignName>sample string 4</CampaignName>
  <CampaignTags>
    <CampaignTags>
      <TagName>sample string 1</TagName>
      <TagValue>sample string 2</TagValue>
    </CampaignTags>
    <CampaignTags>
      <TagName>sample string 1</TagName>
      <TagValue>sample string 2</TagValue>
    </CampaignTags>
  </CampaignTags>
  <ClientId>sample string 1</ClientId>
  <DispositionKeys>sample string 11</DispositionKeys>
  <EndDate>sample string 7</EndDate>
  <GroupKey>sample string 9</GroupKey>
  <IGroupKey>sample string 10</IGroupKey>
  <Secret>sample string 2</Secret>
  <StartDate>sample string 6</StartDate>
  <VerticalId>sample string 8</VerticalId>
  <campaignPreference>
    <BReqCompanyName>true</BReqCompanyName>
    <BReqCustomerName>true</BReqCustomerName>
    <BReqEmail>true</BReqEmail>
    <BReqMobile>true</BReqMobile>
    <BReqMobileVerify>true</BReqMobileVerify>
    <CReqComment>true</CReqComment>
    <CReqCompanyName>true</CReqCompanyName>
    <CReqCustomerName>true</CReqCustomerName>
    <CReqEmail>true</CReqEmail>
    <CReqMobile>true</CReqMobile>
    <CallRecord>true</CallRecord>
    <CustomAction>
      <CustomAction>
        <Label>sample string 3</Label>
        <Type>sample string 1</Type>
        <Value>sample string 2</Value>
        <Visibility>4</Visibility>
      </CustomAction>
      <CustomAction>
        <Label>sample string 3</Label>
        <Type>sample string 1</Type>
        <Value>sample string 2</Value>
        <Visibility>4</Visibility>
      </CustomAction>
    </CustomAction>
    <LogoUrl>sample string 1</LogoUrl>
    <MReqComment>true</MReqComment>
    <MReqCompanyName>true</MReqCompanyName>
    <MReqCustomerName>true</MReqCustomerName>
    <MReqEmail>true</MReqEmail>
    <MReqMobile>true</MReqMobile>
    <PhoneNumber>sample string 2</PhoneNumber>
    <SReqComment>true</SReqComment>
    <SReqCompanyName>true</SReqCompanyName>
    <SReqCustomerName>true</SReqCustomerName>
    <SReqEmail>true</SReqEmail>
    <SReqMobile>true</SReqMobile>
    <SReqRating>true</SReqRating>
    <Type>1</Type>
  </campaignPreference>
</CreateCampaign>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.