Delete Contact
This documentation will describe the delete contact option available when using the Update Contact Information (XMMDALL1) endpoint. This option allows users to remove an existing contact from the specified subscriber account.
See the Authentication documentation for information on how to obtain the authentication headers within the request.
Lock & release reminder
Prior to deleting contacts, confirm you’ve locked the account as explained in the Data Entry Endpoints Introduction documentation.
Once deletions are complete, follow the same documentation to release the account.
Use cases
- Remove outdated contacts from subscriber accounts.
Delete contact
Remove a contact from the specified subscriber account.
Supported attributes
| Attribute | Type | Required | Description |
|---|---|---|---|
| *setMethod | string | Yes | Determines the endpoint you are calling. Must be XMMDALL1 to interact with contacts. |
| OPTION | string | Yes | Determines the method you will be using. Must be DELETE to remove a contact from a subscriber account. |
| ACCOUNT_NUMBER | string | Yes | The subscriber account number (9 character max). |
| RESERVED_MDA | string | Yes | The session ID used when locking the account. The session ID must match to access account information. |
| DEFAULT_LIST_NO | string | Yes | The ID of the contact you wish to delete. Users can either use the Load Contact option or the Passcode Lookup endpoint to view contact Default List Numbers. |
If the contact being deleted is a premises contact (Default List Number below
07), please note the Default List Numbers of any remaining premises contacts will update. If you are deleting more than one premises contact, perform aLOADto obtain the new Default List Numbers as necessary.
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=DELETE \
--form ACCOUNT_NUMBER=KMN12 \
--form RESERVED_MDA=_DOC \
--form DEFAULT_LIST_NO=12
Example response
{
"RESULTS": "SUCCESS"
}