Create share¶

Share your addressbook with other MailUsers

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

Request parameters¶

Parameter	Type	Description	Required
friendly_name	str	Name (identifier) of addressbook	Required
recipients	list	List of recipient addresses	Required

Response parameters¶

Parameter	Type	Description
friendly_name	str	Name (identifier) of addressbook
recipients	list	List of recipient addresses
status	str	Status
url	str	URL of CardDAV addressbook

Example request (Python)¶

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/contacts/share/"
data = {
"friendly_name" : "default",
"recipients" : ["u1@vonmail.com", "u2@vonmail.com"]
}
r = requests.post(url, json=data, auth=("ab@vonmail.com","long-auth_token-here"))
try:
    pprint(r.json())
except: 
    print(r.text)

Example response (JSON)¶

{'friendly_name': 'default',
 'recipients': ['u1@vonmail.com', 'u2@vonmail.com'],
 'status': 'applying',
 'url': 'https://example.domain.tld/radicale/ab@vonmail.com/67763625-112a-405a-a169-598fe63e11af/'}