Eloqua Delete
In this article
Overview
This Snap invokes an Eloqua REST API Delete endpoint to delete an Eloqua object of a specified type.
Expected input: Each input document should specify the ID of an object of the given type to delete. Any other content in an input document is ignored.
Expected output: The Snap outputs exactly one document for each object successfully deleted, specifying the ID of the deleted object.
Snap Type
The Eloqua Delete Snap is a Write-type Snap.
Prerequisites
None
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
| JSON Generator | This Snap has at most one document input view, which can be used to supply documents containing object IDs. The Snap will invoke the Eloqua endpoint once for each input document. |
Output | Document |
| Mapper | This Snap has at most one document output view and produces one document in the view for each successful call to the Eloqua endpoint. |
Error Handling | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
Snap Settings
Field Name | Field Type | Field Dependency | Description |
---|---|---|---|
Label Default Value: Eloqua Delete Example:Create Accounts | String | N/A | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. |
Core object type Example: Contacts | Dropdown list | N/A | Required. The type of core object to delete. The options available include:
All types without a specified version number are version 1.0. |
ID Default Value: None | String | N/A | Required. An identifier for the entity or an expression that evaluates to one. When there is an input view, this should be an expression that specifies the path of the ID value in each input document, such as "$id". |
Pass through Default Value: Deselected | Checkbox | N/A | Select this checkbox to enable the Snap to pass the input document to the output view under the key |
Snap Execution | Dropdown list | N/A | Select one of the three modes in which the Snap executes. Available options are:
|
Examples
Sample Input Document
{
"contactId": "49",
...all other fields ignored
}
Sample Output Document
{
"id": "49"
}
Sample Error Document
{
"reason": "Object Not Found (id: 49)",
"status_code": 404,
"original": {
"contactId": "49",
...
},
"error": "The DELETE request failed",
"url": "https://secure.p02.eloqua.com/API/REST/2.0/data/contact/49"
}
Snap Pack History
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.