Manage Contact Emails

This documentation will describe the available contact email options available when using the Update Contact Information (XMMDALL1) endpoint. These options allow users to manage email addresses assigned to contacts data entered on accounts.

See the Authentication documentation for information on how to obtain the authentication headers within the request.

Use cases

  • Manage email addresses assigned to contacts
  • Verify email addresses assigned to contacts

Lock & release reminder

Prior to editing contacts, confirm you’ve locked the account as explained in the Data Entry Endpoints Introduction documentation.

Once edits are complete, follow the same documentation to release the account.

Load email

View a contact’s assigned email addresses.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMMDALL1 to interact with contacts.
OPTIONstringYesDetermines the method you will be using. Must be LOAD_EMAIL to view contact emails.
ACCOUNT_NUMBERstringYesThe subscriber account number (9 character max).
RESERVED_MDAstringYesThe session ID used when locking the account. The session ID must match to access account information.
DEFAULT_LIST_NOstringYesThe ID of the contact you wish to view.

Example request 

curl --location "https://example.securemcloud.com/rest/rest.php?dataSource=methods&*view=xmsubmit" \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \
--form '*setMethod=XMMDALL1' \
--form OPTION=LOAD_EMAIL \
--form ACCOUNT_NUMBER=KMN12 \
--form RESERVED_MDA=_DOC \
--form DEFAULT_LIST_NO=11

Example response 

{
  "XMEMLACT": {
    "DCEMLACT": {
      "E_MAIL_ADDRESS_KEY": "    KMN12~",
      "E_MAIL_ADDRESS_UNIQ": "11  !",
      "E_MAIL_ADDRESS": "email.example@example.com                                      ",
      "DISPLAY_NAME": "John Smith                                                  "
    }
  },
  "HIDDEN": {
    "HIDDEN_KEY": "0000000000000000.0000000000000000000000000000000000000000000000000000000"
  }
}

Add email

Add a new email address to a contact.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMMDALL1 to interact with contacts.
OPTIONstringYesDetermines the method you will be using. Must be UPDATE_DCMLACT to update contact emails.
ACCOUNT_NUMBERstringYesThe subscriber account number (9 character max).
RESERVED_MDAstringYesThe session ID used when locking the account. The session ID must match to access account information.
DE_MODEstringYes
HIDDEN_KEYstringYesThe HIDDEN_KEY provided when you locked the account.
DISPLAY_NAMEstringYesThe first and last name you wish to assign to the email address (20 character max).
DEFAULT_LIST_NOstringYesThe ID of the contact you will be updating.
E_MAIL_ADDRESSstringYesThe email address you wish to add to the contact (60 character max).

Example request 

curl --location "https://example.securemcloud.com/rest/rest.php?dataSource=methods&*view=xmsubmit" \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \
--form '*setMethod=XMMDALL1' \
--form OPTION=UPDATE_DCMLACT \
--form ACCOUNT_NUMBER=KMN12 \
--form DE_MODE=TRUE \
--form DEFAULT_LIST_NO=12 \
--form RESERVED_MDA=_DOC \
--form HIDDEN_KEY=0000000000000000.0000000000000000000000000000000000000000000000000000000 \
--form 'DISPLAY_NAME=Jessica Sage' \
--form E_MAIL_ADDRESS=jessica.sage@example.com

Example response 

{
  "RESULTS": "SUCCESS"
}
← Load Contact
View Account History →