Campaign API Parameters
Parameters are optional unless otherwise noted.
|
Parameter |
Description |
Notes |
|---|---|---|
|
changeStamp |
The change stamp of the campaign record. |
Integer. Defaults to 0. Required for PUT. For more information, see changeStamp. |
|
chatInvitationFeed |
The chat invitation feed for the campaign (must be a chat feed); must be set to a feed's reference URL. |
A chat invitation feed is required to invite users to chat from the Customer Collaboration Platform reply templates. |
|
description |
The description of the campaign. | |
|
excludeExpr |
The searching expression to exclude. | |
|
feeds |
A list of feeds linked to the campaign. | |
|
filters |
A list of filters linked to the campaign. | |
|
includeExpr |
The searching expression to include. | |
|
metrics (socialContactCount) |
URL Parameter for GET and GET list. |
True/false. Defaults to false. If "true", a count of the social contacts in each campaign is returned. If "false", no social contact count is returned. |
|
name |
The name of the campaign. |
Required for POST. |
|
publicId |
URL-encoded version of name. Must be unique within object type. | |
|
refURL |
A copy of the URL requested. | |
|
suggestedTags |
Up to ten suggested tags for the campaign. | |
|
summary |
URL Parameter for List. |
True/false. Defaults to false. If "true", only the URLs of the objects are returned. If "false", full object information is returned along with the URLs of the objects. |