Activate a program

post

/api/REST/2.0/assets/program/active/{id}

Activates the program specified by the id parameter.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : Program
Type: object
Title: Program
Show Source
Nested Schema : elements
Type: array
A list of program elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the program granted to your current instance. This is a read-only property.
Show Source
Nested Schema : CampaignElement
Type: object
Title: CampaignElement
Show Source
Nested Schema : outputTerminals
Type: array
A list of the campaign element ids within the campaign. This is a read-only property.
Show Source
Nested Schema : permissions
Type: array
The permissions for the campaign element granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Position
Type: object
Title: Position
Show Source
Nested Schema : CampaignOutputTerminal
Type: object
Title: CampaignOutputTerminal
Show Source
Nested Schema : permissions
Type: array
The 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.
Back to Top

Examples

The following examples demonstrate how to activate a program using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Immediately activate the program with the Id #3:


POST /api/REST/2.0/assets/program/active/3?runAsUserId=9
Content-Type: application/json 
			

Response:


{
  "type": "Program",
  "currentStatus": "Active",
  "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/active/3?runAsUserId=9
			

HTTP Request Example

Activate the program with the Id #7 at a later date and time:


POST /assets/program/active/7?runAsUserId=9&scheduledFor=1547670060
Content-Type: application/json 
			

Response:


{
  "type": "Program",
  "currentStatus": "Scheduled",
  "id": "7",
  "createdAt": "1453747647",
  "createdBy": "9",
  "depth": "minimal",
  "folderId": "3669",
  "name": "Docs Program",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "scheduledFor": "1547670060",
  "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/7?runAsUserId=9&scheduledFor=1547670060
			
Back to Top