---
title: "POST /api/v2/shared-calendars/"
method: POST
path: "/api/v2/shared-calendars/"
tags: ["shared-calendars"]
---

# POST /api/v2/shared-calendars/

`POST /api/v2/shared-calendars/`

Shared calendar viewset.

## Request body

- SharedCalendar — Shared calendar serializer.
  - `pk` integer, required
  - `name` string, required
  - `color` string
  - `path` string, required
  - `domain` Domain, required — Domain serializer for v2 API.
    - `pk` integer, required
    - `name` string, required — The domain name
    - `quota` string — Quota shared between mailboxes. Can be expressed in KB, MB (default) or GB. A value of 0 means no quota.
    - `default_mailbox_quota` string — Default quota in MB applied to mailboxes. A value of 0 means no quota.
    - `enabled` boolean — Check to activate this domain
    - `type` string
    - `enable_dkim` boolean — If you activate this feature, a DKIM key will be generated for this domain.
    - `dkim_key_selector` string
    - `dkim_key_length` union
      - 1024 | 2048 | 4096 — * `1024` - 1024 * `2048` - 2048 * `4096` - 4096
      - unknown
    - `dkim_public_key` string, required
    - `dkim_private_key_path` string
    - `mailbox_count` integer, required
    - `mbalias_count` integer, required
    - `domainalias_count` integer, required
    - `dns_global_status` string, required — Return global DNS status.
    - `message_limit` integer, nullable — Number of messages this domain can send per day
    - `creation` string, date-time, required
    - `last_modification` string, date-time, required
    - `allocated_quota_in_percent` string, required
    - `enable_dns_checks` boolean, required — Check to enable DNS checks for this domain
    - `domain_admin` CreateDomainAdmin — Sub serializer for domain administrator creation.
      - `username` string, required
      - `password` string
      - `with_mailbox` boolean
      - `with_aliases` boolean
    - `transport` Transport — Serializer for Transport model.
      - `service` string, required
      - `settings` object, required
    - `opened_alarms_count` integer, required — Number of alarms currently opened for this domain.
    - `sent_messages` string, required
    - `sent_messages_in_percent` integer, nullable, required — Return number of sent messages as a percentage.
    - `last_dns_check_execution` string, date-time, nullable
  - `full_url` string, required
  - `share_url` string, required

## Response `201`

- SharedCalendar — Shared calendar serializer.
  - `pk` integer, required
  - `name` string, required
  - `color` string
  - `path` string, required
  - `domain` Domain, required — Domain serializer for v2 API.
    - `pk` integer, required
    - `name` string, required — The domain name
    - `quota` string — Quota shared between mailboxes. Can be expressed in KB, MB (default) or GB. A value of 0 means no quota.
    - `default_mailbox_quota` string — Default quota in MB applied to mailboxes. A value of 0 means no quota.
    - `enabled` boolean — Check to activate this domain
    - `type` string
    - `enable_dkim` boolean — If you activate this feature, a DKIM key will be generated for this domain.
    - `dkim_key_selector` string
    - `dkim_key_length` union
      - 1024 | 2048 | 4096 — * `1024` - 1024 * `2048` - 2048 * `4096` - 4096
      - unknown
    - `dkim_public_key` string, required
    - `dkim_private_key_path` string
    - `mailbox_count` integer, required
    - `mbalias_count` integer, required
    - `domainalias_count` integer, required
    - `dns_global_status` string, required — Return global DNS status.
    - `message_limit` integer, nullable — Number of messages this domain can send per day
    - `creation` string, date-time, required
    - `last_modification` string, date-time, required
    - `allocated_quota_in_percent` string, required
    - `enable_dns_checks` boolean, required — Check to enable DNS checks for this domain
    - `domain_admin` CreateDomainAdmin — Sub serializer for domain administrator creation.
      - `username` string, required
      - `password` string
      - `with_mailbox` boolean
      - `with_aliases` boolean
    - `transport` Transport — Serializer for Transport model.
      - `service` string, required
      - `settings` object, required
    - `opened_alarms_count` integer, required — Number of alarms currently opened for this domain.
    - `sent_messages` string, required
    - `sent_messages_in_percent` integer, nullable, required — Return number of sent messages as a percentage.
    - `last_dns_check_execution` string, date-time, nullable
  - `full_url` string, required
  - `share_url` string, required

---

[API](https://skmtc.net/modoboa/apis/modoboa-api.md) · [All operations](https://skmtc.net/modoboa/apis/modoboa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modoboa/modoboa-api/versions/01f8eaf44cc7/schema)