Eloqua Application API Form endpoints – “resendLimit” property for Send Submitter an Email form processing step being removed (Nov 2018)

Version 2

    Overview

     

    With the arrival of Eloqua release 18D (Nov 16 - 17, 2018), the resendLimit property introduced in 18A will be removed from the processingSteps type FormStepSendEmail for Application API Form endpoints.

     

    What’s changing?

     

    With 18D, we are removing the resendLimit property to the processingSteps type FormStepSendEmail impacting the following Application API Form endpoints:

    • 1.0
    • 2.0 (The 2.0 endpoints are fully supported, and will be documented soon)
      • Retrieve a list of forms: GET /api/REST/2.0/assets/forms
        • Default depth is minimal
      • Retrieve an form: GET /api/REST/2.0/assets/form/{id}
        • Default depth is complete
      • Create a form: POST /api/REST/2.0/assets/form
        • Default depth is complete
      • Update a form: PUT /api/REST/2.0/assets/form/{id}
        • Default depth is complete

     

    Notes:

    • The processingSteps are only returned at complete depth
    • As of 18B:
      • "Email Resend Limit" no longer can be changed at form processing step level, and no longer appears in the Form Editor
      • Form submission will automatically start using limit set at the admin level
      • When creating or updating a Form using the API, even if including a specific resendLimit value, resendLimit will always be returned with the limit set at the admin level

    • With 18D:
      • When creating or updating a Form using the API, whether resendLimit is included or not included in the request, resendLimit will not be returned
    • This update applies to both 1.0 and 2.0; however, all examples are using the Form 2.0 endpoints, and it’s recommended to use 2.0, as some features are only available on 2.0

     

    Example – Retrieving Forms

     

    Prior to 18D, resendLimit is returned:

     

    GET /api/REST/2.0/assets/forms?search=BEFORE_18D_Email_Resend&depth=complete

     

    Response:

     

    {

      "elements": [

        {

          "type": "Form",

          "currentStatus": "Draft",

          "id": "57",

          "createdAt": "1528316452",

          "createdBy": "11",

          "depth": "complete",

          "folderId": "7",

          "name": "BEFORE_18D_Email_Resend",

          "permissions": [

            "Retrieve",

            "SetSecurity",

            "Delete",

            "Update"

          ],

          "updatedAt": "1528316452",

          "updatedBy": "11",

          "customCSS": "…",

          "defaultKeyFieldMapping": {

            "type": "FormFieldUpdateMapping",

            "sourceFormFieldId": "348",

            "targetEntityFieldId": "100001"

          },

          "elements": [

            {

              "type": "FormField",

              "id": "348",

              "name": "Email Address",

              "style": "{\"fieldSize\":\"large\",\"labelPosition\":\"top\"}",

              "createdFromContactFieldId": "100001",

              "dataType": "text",

              "displayType": "text",

              "fieldMergeId": "1",

              "htmlName": "emailAddress",

              "useGlobalSubscriptionStatus": "False",

              "validations": []

            },

            {

              "type": "FormField",

              "id": "349",

              "name": "Submit",

              "style": "{\"submitButtonStyleType\":\"standard\",\"submitButtonWidthStyle\":\"100px\",\"submitButtonHeightStyle\":\"24px\"}",

              "altText": "Submit",

              "dataType": "text",

              "displayType": "submit",

              "htmlName": "submit",

              "useGlobalSubscriptionStatus": "False",

              "validations": []

            }

          ],

          "html": "…",

          "htmlName": "BEFORE_18D_Email_Resend",

          "processingSteps": [

            {

              "type": "FormStepSendEmail",

              "id": "253",

              "name": "Send Email",

              "execute": "always",

              "allowResend": "yes",

              "emailAddressFormFieldId": "348",

              "emailId": {

                "type": "ProcessingStepValueWithLookup",

                "constantValue": "108",

                "valueType": "constant"

              },

              "resendLimit": "100"

            }

          ],

          "processingType": "externalWebsite",

          "size": {

            "type": "Size",

            "width": "0",

            "height": "0"

          },

          "style": "{\"fieldSize\":\"medium\",\"labelPosition\":\"top\"}",

          "submitFailedLandingPageId": "8"

        }

      ],

      "page": 1,

      "pageSize": 1000,

      "total": 1

    }

     

    After 18D, resendLimit will no longer be returned:

     

    GET /api/REST/2.0/assets/forms?search=AFTER_18D_No_Email_Resend&depth=complete

     

    Response:

     

    {

      "elements": [

        {

          "type": "Form",

          "currentStatus": "Draft",

          "id": "57",

          "createdAt": "1528316452",

          "createdBy": "11",

          "depth": "complete",

          "folderId": "7",

          "name": "AFTER_18D_No_Email_Resend",

          "permissions": [

            "Retrieve",

            "SetSecurity",

            "Delete",

            "Update"

          ],

          "updatedAt": "1528316452",

          "updatedBy": "11",

          "customCSS": "…",

          "defaultKeyFieldMapping": {

            "type": "FormFieldUpdateMapping",

            "sourceFormFieldId": "348",

            "targetEntityFieldId": "100001"

          },

          "elements": [

            {

              "type": "FormField",

              "id": "348",

              "name": "Email Address",

              "style": "{\"fieldSize\":\"large\",\"labelPosition\":\"top\"}",

              "createdFromContactFieldId": "100001",

              "dataType": "text",

              "displayType": "text",

              "fieldMergeId": "1",

              "htmlName": "emailAddress",

              "useGlobalSubscriptionStatus": "False",

              "validations": []

            },

            {

              "type": "FormField",

              "id": "349",

              "name": "Submit",

              "style": "{\"submitButtonStyleType\":\"standard\",\"submitButtonWidthStyle\":\"100px\",\"submitButtonHeightStyle\":\"24px\"}",

              "altText": "Submit",

              "dataType": "text",

              "displayType": "submit",

              "htmlName": "submit",

              "useGlobalSubscriptionStatus": "False",

              "validations": []

            }

          ],

          "html": "…",

          "htmlName": "AFTER_18D_No_Email_Resend",

          "processingSteps": [

            {

              "type": "FormStepSendEmail",

              "id": "253",

              "name": "Send Email",

              "execute": "always",

              "allowResend": "yes",

              "emailAddressFormFieldId": "348",

              "emailId": {

                "type": "ProcessingStepValueWithLookup",

                "constantValue": "108",

                "valueType": "constant"

              }

            }

          ],

          "processingType": "externalWebsite",

          "size": {

            "type": "Size",

            "width": "0",

            "height": "0"

          },

          "style": "{\"fieldSize\":\"medium\",\"labelPosition\":\"top\"}",

          "submitFailedLandingPageId": "8"

        }

      ],

      "page": 1,

      "pageSize": 1000,

      "total": 1

    }

     

    Example – Creating Forms

     

    After 18D, if resendLimit is included in the request, resendLimit will not be returned, which is the same result if resendLimit is not included:

     

    POST/api/REST/2.0/assets/form

    {

      "type": "Form",

      "name": "AFTER_18D_Email_Resend_API",

      "elements": [

        {

          "type": "FormField",

          "id": "-1",

          "name": "Email Address",

          "style": "{\"fieldSize\":\"large\",\"labelPosition\":\"top\"}",

          "createdFromContactFieldId": "100001",

          "dataType": "text",

          "displayType": "text",

          "fieldMergeId": "1",

          "htmlName": "emailAddress",

          "validations": []

        },

        {

          "type": "FormField",

          "id": "-2",

          "name": "Submit",

          "style": "{\"submitButtonStyleType\":\"standard\",\"submitButtonWidthStyle\":\"100px\",\"submitButtonHeightStyle\":\"24px\"}",

          "dataType": "text",

          "displayType": "submit",

          "htmlName": "submit",

          "validations": []

        }

      ],

      "emailAddressFormFieldId": "-1",

      "htmlName": "AFTER_18D_Email_Resend_API",

      "processingSteps": [

        {

          "type": "FormStepSendEmail",

          "id": "-3",

          "name": "Send Email",

          "execute": "always",

          "allowResend": "yes",

          "emailAddressFormFieldId": "-1",

          "emailId": {

            "type": "ProcessingStepValueWithLookup",

            "constantValue": "108",

            "valueType": "constant"

          },

          "resendLimit": "100"

        }

      ]

    }

     

    Response:

     

    {

      "type": "Form",

      "currentStatus": "Draft",

      "id": "3907",

      "createdAt": "1528317578",

      "createdBy": "71",

      "depth": "complete",

      "folderId": "7",

      "name": "AFTER_18D_Email_Resend_API",

      "permissions": [

        "Retrieve",

        "SetSecurity",

        "Delete",

        "Update"

      ],

      "updatedAt": "1528317578",

      "updatedBy": "71",

      "elements": [

        {

          "type": "FormField",

          "id": "24427",

          "initialId": "-1",

          "name": "Email Address",

          "style": "{\"fieldSize\":\"large\",\"labelPosition\":\"top\"}",

          "createdFromContactFieldId": "100001",

          "dataType": "text",

          "displayType": "text",

          "fieldMergeId": "1",

          "htmlName": "emailAddress",

          "useGlobalSubscriptionStatus": "False",

          "validations": []

        },

        {

          "type": "FormField",

          "id": "24428",

          "initialId": "-2",

          "name": "Submit",

          "style": "{\"submitButtonStyleType\":\"standard\",\"submitButtonWidthStyle\":\"100px\",\"submitButtonHeightStyle\":\"24px\"}",

          "dataType": "text",

          "displayType": "submit",

          "htmlName": "submit",

          "useGlobalSubscriptionStatus": "False",

          "validations": []

        }

      ],

      "htmlName": "AFTER_18D_Email_Resend_API",

      "processingSteps": [

       {

          "type": "FormStepSendEmail",

          "id": "9764",

          "initialId": "-3",

          "name": "Unknown",

          "execute": "always",

          "allowResend": "yes",

          "emailAddressFormFieldId": "24427",

          "emailId": {

            "type": "ProcessingStepValueWithLookup",

            "constantValue": "108",

            "valueType": "constant"

          }

        }

      ],

      "processingType": "externalWebsite"

    }

     

     

    Timeline

     

    With the arrival of Eloqua release 18D, the resendLimit property, introduced in 18A, will be removed from the processingSteps type FormStepSendEmail for Application API Form endpoints. Release 18D is anticipated to arrive between Nov 16 - 17, 2018. Check the Eloqua Release Center for specific dates and times.

     

    Next Steps

     

    If retrieving Forms via the Application API, prepare for the resendLimit property to no longer be returned when there is a FormStepSendEmail within processingSteps.

     

    If creating or updating Forms via the Application API, the resendLimit property can be removed. If including resendLimit within the request to create or update a Form, the Form will still be created or updated, and the resendLimit will be ignored and not returned in the response.

     

    Additional Resources

     

    View changes for Eloqua's APIs including, new features, significant recent changes, and platform notices, on the Eloqua Developer Changelog.

     

    If you have questions, post a discussion on Code It!

     

     

    FAQ

     

    Q: What endpoints are impacted by this change?

    A: All Form Application API endpoints (1.0 and 2.0), except DELETE endpoints.

     

    Q: I do not see the Form Application 2.0 endpoints within published endpoints, are they officially supported?

    A: Yes, the Form Application 2.0 endpoints are officially supported, and we are currently working on adding these endpoints to our officially supported documentation.

     

    Q: If resendLimit is included in a create or update request, will the request still be successful?

    A: If including resendLimit within the request to create or update a Form, the Form will still be created or updated, and the resendLimit will be ignored and not returned in the response.

     

    Q: Can allowResend be set to “systemDefault”, as it was a possible value before this property was introduced?

    A: No. allowResend still can only be set to “yes” or “no”. Default is still no longer an option in the Forms editor, and if setting allowResend to “systemDefault” when creating or updating it will result in a 500 error.

     

    Q: Where is the Admin setting located?

    A: This setting is located within Settings > Security > Form Configuration.