get_deleted_contacts
The get_deleted_contacts method retrieves a list of deleted restorable contacts from a user's Webmail address book.
Syntax
{
<credentials object>,
"user": <mailbox_name>
}
Request fields for get_deleted_contacts
The following fields can be used in the get_deleted_contacts method:
Field name | Obligation | Definition/Value |
---|---|---|
user | Required | The user's mailbox name. |
Response fields for get_deleted_contacts
The following fields may be returned in response to the get_deleted_contacts method:
Field name | Obligation | Description/Value |
---|---|---|
contacts | Returned if success = true | A list of the contacts that can be recovered. For each contact listed, the following information is returned: company, email, firstname, home_addr, home_phone, id, lastname, mobile_phone, nickname, notes, title, work_address, work_phone |
count | Returned if success = true | The number of contacts returned. |
error | Returned if success = false | A text string that explains the error. |
error_number | Returned if success = false | A number that represents the error. |
success | Always returned | Indicates whether the request was successful or not. Allowed values are true and false. |
Examples for get_deleted_contacts
Request
{
"credentials": {
"user": "[email protected]",
"password": "pencil75"
},
"user": "[email protected]"
}
Response
{
"success": true,
"count": 3,
"contacts": [
{
"home_phone": "(555) 555-5555",
"firstname": "Bob",
"nickname": "Bobby",
"work_address": "",
"lastname": "Bobson",
"email": "[email protected]",
"notes": null,
"id": "1321909823__1321909700169",
"title": "Dr.",
"mobile_phone": "",
"company": "Bob Co.",
"work_phone": "(923) 456-7890 ",
"home_addr": ""
},
{
"home_phone": "",
"firstname": "Betty",
"nickname": "Bets",
"work_address": "",
"lastname": "Bobson",
"email": "[email protected]",
"notes": null,
"id": "1321909823__1321909823568",
"title": "Ms.",
"mobile_phone": "",
"company": "",
"work_phone": "",
"home_addr": "123 Oak St.\nSpringfield IL\n56453\n"
},
{
"home_phone": "",
"firstname": "William",
"nickname": "Billy", "work_address": "",
"lastname": "Bobson",
"email": "[email protected]",
"notes": null,
"id": "1321909823__1321909754264",
"title": "Mr.",
"mobile_phone": "(753) 867-5309",
"company": "",
"work_phone": "",
"home_addr": ""
}
]
}
Updated less than a minute ago