Get Campaigns
Returns a list of campaign records.
Note: This endpoint has been superseded. Use Get Smart Campaigns endpoint instead.
Parameters
Query 7
id array of integer Comma-separated list of campaign ids to return records for
name array of string Comma-separated list of names to filter on
programName array of string Comma-separated list of program names to filter on. If set, will filter to only campaigns which are children of the designated programs.
workspaceName array of string Comma-separated list of workspace names to filter on. If set, will only return campaigns in the given workspaces.
batchSize integer (int32) Maximum number of records to return. Maximum and default is 300.
nextPageToken string A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.
isTriggerable boolean Set to true to return active Campaigns which have a Campaign is Requested trigger and source is Web Service API
Responses
200 OK ResponseOfCampaign
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of Campaign required
Array of results for individual records in the operation, may be empty
Model Campaign
active boolean Whether the campaign is active. Only applicable to trigger campaigns
createdAt string required Datetime when the campaign was created
description string Description of the Smart Campaign
id integer (int32) required Unique integer id of the Smart Campaign
name string required Name of the Smart Campaign
programId integer (int32) Id of the parent program if applicable
programName string Name of the parent program if applicable
type string required Type of the Smart Campaign
Values batch trigger
updatedAt string required Datetime when the campaign was most recently updated
workspaceName string Name of the parent workspace if applicable
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Generated example
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"nextPageToken": "example-token",
"requestId": "123",
"result": [
{
"active": false,
"createdAt": "string",
"description": "string",
"id": 123,
"name": "Example name",
"programId": 123,
"programName": "Example name",
"type": "batch",
"updatedAt": "string",
"workspaceName": "Example name"
}
],
"success": false,
"warnings": [
{
"code": 123,
"message": "string"
}
]
}Referenced models
Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.