Search Results

Input and Output of Retrieve Campaigns

When you use the Campaigns resource, the information in the Input and Output tabs varies depending on the endpoint that you select.

Input and Output for Campaign by Id

If you select the Campaign by Id endpoint, the Input tab contains the following element:
Input Item Data Type Description
id String The ID of the campaign.
The Output tab contains the following elements:
Output Item Data Type Description
requestId String The request ID returned from the Marketo server.
result Complex The fields that are displayed in the response. The following fields are displayed: id, name, description, programName, createdAt, updatedAt, type, workspaceName, and active.
success Boolean If the request is successful, this value is true.

Input and Output for Multiple Campaigns

If you select the Multiple Campaigns endpoint, the Input tab contains the following elements:
Input Item Data Type Description
ids Complex The ID of the campaign. Multiple campaign IDs are supported.
names Complex The name of the campaign. Multiple campaign names are supported.
programNames Complex The program name of the campaign. Multiple program names are supported.
workspaceNames Complex The workspace name of the campaign. Multiple workspace names are supported.
batchSize Integer The maximum number of records to be returned in a single call. The default maximum number of the batch size is 300.
nextPageToken String This parameter is used to paginate through large result sets. This value can be used to access next set of records.
Note: The value of the next page token is obtained from the output of the previous activity.
The Output tab contains the following elements:
Output Item Data Type Description
requestId String The request ID returned from the Marketo server.
result Complex The fields that are displayed in the response. The following fields are displayed: id, name, description, programName, createdAt, updatedAt, type, workspaceName, and active.
success Boolean If the request is successful, this value is true.
nextPageToken String This token is returned by an API call. This value can be used to access next set of records.