Jump to

• Request
• Response

Create a signature rule

post

/api/rest/2.0/assets/email/signature/rule

Creates a signature rule with the provided settings. The settings for contactFieldId, customObjectFieldId , and eventRegistrationId are exclusive. Providing more than one of these values will result in an error.

Request

Supported Media Types

• application/json

Body ()

The request body defines the details of the signature rule to be created.

Root Schema : EmailSignatureRule

Type: object

Title: EmailSignatureRule

Show Source

• contactFieldId: string
  The id for the contact field to be used when matching a contact to a mapping.
• createdAt: string
  Read Only: true

  The date and time the signature rule was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the signature rule.
• createdByName: string
  The name of the user who created the signature rule.
• customObjectFieldId: string
  The id for the custom object field to be used when matching a contact to a mapping.
• defaultSenderId: string
  The id of the user that will be used as the default sender if no mappings are matched.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• eventRegistrationFieldId: string
  The id for the event field to be used when matching a contact to a mapping.
• id: string
  Read Only: true

  Id of the signature rule. This is a read-only property.
• isPersonalizeFromAddress: string
  Flag to enable personalizing the from address.
• isPersonalizeFromName: string
  Flag to enable personalizing the from name.
• isPersonalizeReplyAddress: string
  Flag to enable personalizing the reply to address.
• isPersonalizeReplyName: string
  Flag to enable personalizing the reply to name.
• name: string
  The name of the signature rule.
• permissions: array permissions
  The permissions for the signature rule granted to your current instance. This is a read-only property.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  The date and time the signature rule was last updated, expressed in Unix time.
• updatedBy: string
  Read Only: true

  The login id of the user who last updated the signature rule.
• updatedByName: string
  The name of the user who last updated the signature rule.

{
    "title":"EmailSignatureRule",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the signature rule. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The name of the signature rule."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the signature rule granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the signature rule."
        },
        "createdByName":{
            "type":"string",
            "description":"The name of the user who created the signature rule."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the signature rule was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who last updated the signature rule."
        },
        "updatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the signature rule."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the signature rule was last updated, expressed in Unix time."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "defaultSenderId":{
            "type":"string",
            "description":"The id of the user that will be used as the default sender if no mappings are matched."
        },
        "contactFieldId":{
            "type":"string",
            "description":"The id for the contact field to be used when matching a contact to a mapping."
        },
        "customObjectFieldId":{
            "type":"string",
            "description":"The id for the custom object field to be used when matching a contact to a mapping."
        },
        "eventRegistrationFieldId":{
            "type":"string",
            "description":"The id for the event field to be used when matching a contact to a mapping."
        },
        "isPersonalizeFromName":{
            "type":"string",
            "description":"Flag to enable personalizing the from name."
        },
        "isPersonalizeFromAddress":{
            "type":"string",
            "description":"Flag to enable personalizing the from address."
        },
        "isPersonalizeReplyName":{
            "type":"string",
            "description":"Flag to enable personalizing the reply to name."
        },
        "isPersonalizeReplyAddress":{
            "type":"string",
            "description":"Flag to enable personalizing the reply to address."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the signature rule granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the signature rule granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : EmailSignatureRule

Type: object

Title: EmailSignatureRule

Show Source

• contactFieldId: string
  The id for the contact field to be used when matching a contact to a mapping.
• createdAt: string
  Read Only: true

  The date and time the signature rule was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the signature rule.
• createdByName: string
  The name of the user who created the signature rule.
• customObjectFieldId: string
  The id for the custom object field to be used when matching a contact to a mapping.
• defaultSenderId: string
  The id of the user that will be used as the default sender if no mappings are matched.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• eventRegistrationFieldId: string
  The id for the event field to be used when matching a contact to a mapping.
• id: string
  Read Only: true

  Id of the signature rule. This is a read-only property.
• isPersonalizeFromAddress: string
  Flag to enable personalizing the from address.
• isPersonalizeFromName: string
  Flag to enable personalizing the from name.
• isPersonalizeReplyAddress: string
  Flag to enable personalizing the reply to address.
• isPersonalizeReplyName: string
  Flag to enable personalizing the reply to name.
• name: string
  The name of the signature rule.
• permissions: array permissions
  The permissions for the signature rule granted to your current instance. This is a read-only property.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  The date and time the signature rule was last updated, expressed in Unix time.
• updatedBy: string
  Read Only: true

  The login id of the user who last updated the signature rule.
• updatedByName: string
  The name of the user who last updated the signature rule.

{
    "title":"EmailSignatureRule",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the signature rule. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The name of the signature rule."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the signature rule granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the signature rule."
        },
        "createdByName":{
            "type":"string",
            "description":"The name of the user who created the signature rule."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the signature rule was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who last updated the signature rule."
        },
        "updatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the signature rule."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the signature rule was last updated, expressed in Unix time."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "defaultSenderId":{
            "type":"string",
            "description":"The id of the user that will be used as the default sender if no mappings are matched."
        },
        "contactFieldId":{
            "type":"string",
            "description":"The id for the contact field to be used when matching a contact to a mapping."
        },
        "customObjectFieldId":{
            "type":"string",
            "description":"The id for the custom object field to be used when matching a contact to a mapping."
        },
        "eventRegistrationFieldId":{
            "type":"string",
            "description":"The id for the event field to be used when matching a contact to a mapping."
        },
        "isPersonalizeFromName":{
            "type":"string",
            "description":"Flag to enable personalizing the from name."
        },
        "isPersonalizeFromAddress":{
            "type":"string",
            "description":"Flag to enable personalizing the from address."
        },
        "isPersonalizeReplyName":{
            "type":"string",
            "description":"Flag to enable personalizing the reply to name."
        },
        "isPersonalizeReplyAddress":{
            "type":"string",
            "description":"Flag to enable personalizing the reply to address."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the signature rule granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the signature rule granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

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