Create an external activity

post

/api/REST/2.0/data/activity

Creates an external activity that matches the criteria specified by the request body.

Request

Supported Media Types
Body ()
The request body defines the details of the external activity to be created.
Root Schema : ExternalActivities
Type: object
Title: ExternalActivities
Show Source
Nested Schema : fieldValues
Type: array
Array containing type and id values for all of the activity fields associated with a given external activity
Show Source
Nested Schema : permissions
Type: array
The permissions for the external activity granted to your current instance. This is a read-only property.
Show Source
Nested Schema : items
Type: object
Additional Properties Allowed
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : ExternalActivities
Type: object
Title: ExternalActivities
Show Source
Nested Schema : fieldValues
Type: array
Array containing type and id values for all of the activity fields associated with a given external activity
Show Source
Nested Schema : permissions
Type: array
The permissions for the external activity granted to your current instance. This is a read-only property.
Show Source
Nested Schema : items
Type: object
Additional Properties Allowed
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 create a new external activity using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Create a new external activity:


POST /api/REST/2.0/data/activity
Content-Type: application/json 
			

Request body:


{
  "name": "Tradeshow 2021",
  "assetName": "Tradeshow 2021",
  "assetType": "Tradeshow",
  "activityType": "Viewed a Demo",
  "activityDate": "1612460136",
  "campaignId": 37,
  "contactId": 2405
}
			

Note:

The activityDate must be included to successfully link an External Activity to a Contact.

Response:


{
  "type": "ExternalActivities",
  "id": "102332",
  "depth": "complete",
  "name": "Tradeshow 2021",
  "activityDate": "1612460136",
  "activityType": "Viewed a Demo",
  "assetName": "Tradeshow 2021",
  "assetType": "Tradeshow",
  "campaignId": 37,
  "contactId": 2405
}
			

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 --data '{"name":"Tradeshow 2021","assetName":"Tradeshow 2021","assetType":"Tradeshow","activityType":"Viewed a Demo","activityDate":"1612460136","campaignId":37,"contactId":2405}' https://secure.p03.eloqua.com/api/REST/2.0/data/activity
			
Back to Top