| 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 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. |