Pause a program
post
/api/rest/2.0/assets/program/pause/{id}
Pauses the program specified by the
id parameter.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Id of the program to pause.
Response
Supported Media Types
- application/json
201 Response
Success
Root Schema : Program
Type:
objectTitle:
Show Source
Program-
createdAt:
string
Read Only:
trueThe date and time the program was created, expressed in Unix time. -
createdBy:
string
Read Only:
trueThe login id of the user who created the program. -
currentStatus:
string
The program's current status: Active, Draft, Scheduled, Paused, or Completed.
-
defaultEntityId:
string
The id of the custom object data set. Only used for custom object programs.
-
defaultEntityType:
string
The program type, possible values are Contact or CustomObjectRecords.
-
depth:
string
Read Only:
trueLevel of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal,partial, andcomplete. Any other values passed are reset tocompleteby default. For more information, see Request depth. -
description:
string
The description of the program.
-
elements:
array elements
A list of program elements.
-
folderId:
string
Read Only:
trueThe folder id of the folder which contains the program. -
id:
string
Read Only:
trueId of the program. -
isExitHistoryDisabled:
string
Program_Field_IsExitHistoryDisabled_Description
-
isMemberAllowedDuplicates:
string
Whether contacts are allowed to enter the program more than once. If false, once a contact enters the program, the contact cannot enter the program again from another entry point.
-
isReadOnly:
string
Whether or not the program is read only.
-
name:
string
The name of the program.
-
permissions:
array permissions
The permissions for the program granted to your current instance. This is a read-only property.
-
runAsUserId:
string
The login id of the user to activate the program.
-
scheduledFor:
string
Read Only:
trueThe date the program is scheduled. -
sourceTemplateId:
string
Id of the template used to create the asset.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
trueUnix timestamp for the date and time the program was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
trueThe login id of the user that last updated the program.
Nested Schema : elements
Type:
arrayA list of program elements.
Show Source
-
Array of:
object CampaignElement
Title:
CampaignElement
Nested Schema : permissions
Type:
arrayThe permissions for the program granted to your current instance. This is a read-only property.
Show Source
Nested Schema : CampaignElement
Type:
objectTitle:
Show Source
CampaignElement-
createdAt:
string
Read Only:
trueThe date and time the campaign element was created, expressed in Unix time. -
createdBy:
string
Read Only:
trueThe login id of the user who created the campaign element. -
currentStatus:
string
The campaign element's current status.
-
depth:
string
Read Only:
trueLevel of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal,partial, andcomplete. Any other values passed are reset tocompleteby default. For more information, see Request depth. -
description:
string
The description of the campaign element.
-
folderId:
string
Read Only:
trueId of the associated folder. -
id:
string
Read Only:
trueId of the campaign element. This is a read-only property. -
memberCount:
string
Amount of members within the campaign element. This is a read-only property.
-
memberErrorCount:
string
Amount of members within the campaign element in errored status. This is a read-only property.
-
name:
string
Name of the campaign element. This is a read-only property.
-
outputTerminals:
array outputTerminals
A list of the campaign element ids within the campaign. This is a read-only property.
-
permissions:
array permissions
The permissions for the campaign element granted to your current instance. This is a read-only property.
-
position:
object Position
Title:
Position -
scheduledFor:
string
Read Only:
trueThe date the campaign element is scheduled. -
sourceTemplateId:
string
The id of the source template.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
trueUnix timestamp for the date and time the campaign element was last updated. -
updatedBy:
string
Read Only:
trueThe login id of the user that last updated the campaign element.
Nested Schema : outputTerminals
Type:
arrayA list of the campaign element ids within the campaign. This is a read-only property.
Show Source
-
Array of:
object CampaignOutputTerminal
Title:
CampaignOutputTerminal
Nested Schema : permissions
Type:
arrayThe permissions for the campaign element granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Position
Type:
objectTitle:
Show Source
Position-
type:
string
The campaign element's type. This is a read-only property.
-
x:
string
The position of the campaign element on the x axis.
-
y:
string
The position of the campaign element on the y axis.
Nested Schema : CampaignOutputTerminal
Type:
objectTitle:
Show Source
CampaignOutputTerminal-
connectedId:
string
The connected id of the campaign output terminal. This is a read-only property.
-
connectedType:
string
The campaign output terminal's connection type. This is a read-only property.
-
createdAt:
string
Read Only:
trueThe date and time the campaign output terminal was created, expressed in Unix time. -
createdBy:
string
Read Only:
trueThe login id of the user who created the campaign output terminal. -
currentStatus:
string
The campaign output terminal's current status.
-
depth:
string
Read Only:
trueLevel of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal,partial, andcomplete. For more information, see Request depth. -
description:
string
The description of the campaign output terminal.
-
folderId:
string
Read Only:
trueId of the associated folder. -
id:
string
Read Only:
trueId of the campaign output terminal. This is a read-only property. -
name:
string
Name of the campaign output terminal.
-
permissions:
array permissions
The permissions for the campaign output terminal granted to your current instance.
-
scheduledFor:
string
Read Only:
trueThe date the campaign output terminal is scheduled. -
sourceTemplateId:
string
The id of the source template.
-
terminalType:
string
The campaign output terminal type. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
trueUnix timestamp for the date and time the campaign output terminal was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
trueThe login id of the user that last updated the campaign output terminal.
Nested Schema : permissions
Type:
arrayThe permissions for the campaign output terminal granted to your current instance.
Show Source
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
The following examples demonstrate how to pause a program using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Pause the program with Id#3:
POST /api/REST/2.0/assets/program/pause/3
Content-Type: application/json
Response:
{
"type": "Program",
"currentStatus": "Paused",
"id": "3",
"createdAt": "1453747647",
"createdBy": "9",
"depth": "minimal",
"folderId": "3669",
"name": "Docs Program",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update",
"Activate"
],
"updatedAt": "1518793888",
"updatedBy": "9",
"defaultEntityType": "Contacts"
}
cURL Example
Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.
curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST https://secure.p03.eloqua.com/api/rest/2.0/assets/program/pause/3