Delete addressbook

Delete addressbook

  • HTTP Method: DELETE
  • URL: https://example.domain.tld/api/v1/contacts/
  • Require authentication: Yes
  • Permission level required: MailUser

Request parameters

Parameter Type Description Required
friendly_name str Name (identifier) of addressbook Required

Response parameters

Parameter Type Description
friendly_name str Name (identifier) of addressbook
status str Status

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/contacts/"
data = {
"friendly_name" : "Office"
}
r = requests.delete(url, json=data, auth=("ab@vonmail.com","long-auth_token-here"))
try:
    pprint(r.json())
except: 
    print(r.text)

Example response (JSON)

{'friendly_name': 'Office', 'status': 'deleting'}