GET
api/REST/2.0/assets/email/signature/rules
Retrieves a list of signature rule assets.
Request parameters
Name |
Description |
Constraints |
---|---|---|
|
Level of detail returned by the request. Learn more about the depth parameter. |
Possible values: "minimal" "partial" "complete" Example: |
count
|
Maximum number of entities to return | Any whole number between 1 and 1000 inclusive.
Example: |
page |
Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default. |
Any positive whole number.
Example: |
search
|
The |
If there are spaces in the You can search with fields even if they are not returned at the depth being used. The following operators are supported on most endpoints:
|
sort
|
Specifies the name of the property used to sort the returned entities. |
The value depends on the type of entity being sorted, with each entity having its own list of sortable properties. Example: |
dir
|
Specifies the direction in which to sort the returned entities. |
"asc" for ascending or "desc" for descending. Example: |
orderBy
|
Specifies the field by which list results are ordered, and the direction. The direction will defaullt to ASC if not specified. |
Any valid asset parameter field. Example: |
lastUpdatedAt
|
When the asset was last updated. Returns deleted assets.Note: For the majority of use cases, it is recommended to use |
A valid date/time value. Example: |
Response parameters
Name |
Type |
Description |
Possible values |
---|---|---|---|
type |
string |
The asset's type in Eloqua. |
|
id | string | Id of the signature rule. | |
createdAt | string | The date and time the signature rule was created. | |
createdBy | string | The login id of the user who created the signature rule. | |
depth | string | The request's level of detail. |
|
name |
string |
The name of the signature rule. |
|
updatedAt | string | Unix timestamp for the date and time the signature rule was last updated. | |
updatedBy | string | The login id of the user that last updated the signature rule. | |
isPersonalizeFromAddress | string | Whether or not the email sender's "From" address is customized in the email header. | |
isPersonalizeFromName | string | Whether or not the email sender's "Display Name" is customized in the email header. | |
isPersonalizeReplyAddress | string | Whether or not the "Reply-To Address" is customized in the email header. | |
isPersonalizeReplyName | string | Whether or not the "Reply-To Display Name" is customized in the email header. |
Example
Retrieve the first two signature rules in your database:
GET /assets/email/signature/rules?count=2
Response:
{
"elements": [
{
"type": "EmailSignatureRule",
"id": "2",
"createdAt": "1417724000",
"createdBy": "12",
"depth": "minimal",
"name": "EC Test Signature Rule",
"updatedAt": "1471936138",
"updatedBy": "71",
"isPersonalizeFromAddress": null,
"isPersonalizeFromName": null,
"isPersonalizeReplyAddress": null,
"isPersonalizeReplyName": null
},
{
"type": "EmailSignatureRule",
"id": "115",
"createdAt": "1460656435",
"createdBy": "2",
"depth": "minimal",
"name": "rl 480 Signature Rule",
"updatedAt": "1460656861",
"updatedBy": "2",
"isPersonalizeFromAddress": null,
"isPersonalizeFromName": null,
"isPersonalizeReplyAddress": null,
"isPersonalizeReplyName": null
}
],
"page": 1,
"pageSize": 2,
"total": 96
}