POST api/v2/interaction/create

Creates a new campaign (interaction), or updates the existing one when a campaign with the same identity already exists for the vertical.

Request Information

URI Parameters

None.

Body Parameters

Campaign definition. ClientId, Secret and CampaignIdentity are required; VerticalId defaults to "1"; CampaignPreference and CampaignTags are optional.

CreateCampaign

Name	Description	Type	Additional information
ClientId	API client id issued from API Credentials. Required.	string	None.
Secret	API secret paired with the client id. Required.	string	None.
Email	Email of the campaign owner/operator.	string	None.
CampaignIdentity	Caller-defined unique identity of the campaign within the vertical; used to decide between create and update. Required.	string	None.
CampaignName	Display name of the campaign.	string	None.
CampaignDescription	Free-text description of the campaign.	string	None.
StartDate	Campaign start date.	string	None.
EndDate	Campaign end date.	string	None.
VerticalId	Vertical the campaign belongs to. Defaults to "1" when omitted.	string	None.
GroupKey	Optional group key to attach the campaign to.	string	None.
IGroupKey	Optional interaction group key.	string	None.
DispositionKeys	Optional comma-separated disposition keys to enable for the campaign.	string	None.
campaignPreference	Optional per-channel required-field settings for participants joining the campaign.	CampaignPreference	None.
CampaignTags	Optional name/value tags stored with the campaign.	Collection of CampaignTags	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": "sample string 1",
  "Secret": "sample string 2",
  "Email": "sample string 3",
  "CampaignIdentity": "sample string 4",
  "CampaignName": "sample string 5",
  "CampaignDescription": "sample string 6",
  "StartDate": "sample string 7",
  "EndDate": "sample string 8",
  "VerticalId": "sample string 9",
  "GroupKey": "sample string 10",
  "IGroupKey": "sample string 11",
  "DispositionKeys": "sample string 12",
  "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 6</CampaignDescription>
  <CampaignIdentity>sample string 4</CampaignIdentity>
  <CampaignName>sample string 5</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 12</DispositionKeys>
  <Email>sample string 3</Email>
  <EndDate>sample string 8</EndDate>
  <GroupKey>sample string 10</GroupKey>
  <IGroupKey>sample string 11</IGroupKey>
  <Secret>sample string 2</Secret>
  <StartDate>sample string 7</StartDate>
  <VerticalId>sample string 9</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

The created or updated interaction (campaign) detail, including its CampaignKey and interaction URLs.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.