Mailbox API

Query String

• Optional

  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • config_name ⁠string
    Specify the config of the product (standard/premium).
  • email ⁠string
  • password ⁠string

    Minimum length: 8

    Maximum length: 200

    Password of the mailbox.

  Optional

  • aliases ⁠array

    Of items of type:

    • string
      A local-part (what comes before the "@") of an email address. It can contain a wildcard "*" before or after at least two characters to redirect everything thats matches the local-part pattern.

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • email ⁠string
    The email address

Query String

• Optional

  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Query String

• Optional

  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • config_name ⁠string

    One of: "standard", "premium"

    Specify the name of the product (standard/premium).
  • duration_month ⁠integer

    One of: 1, 12

    The duration of the subscription 1 or 12 month(s).
  • quantity ⁠integer
    The quantity of slots to purchase.

  Optional

  • autorenew ⁠boolean

    Default: false

    true to enable the autorenewal.

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Query String

• Optional

  • config_name ⁠string
    Filter the list by configuration name
  • expires_at_gte ⁠datetime
    Slot expiration date.
  • expires_at_lte ⁠datetime
    Slot expiration date.
  • last_paid_duration ⁠integer

    One of: 1, 12

    Filters the list by last paid duration
  • page ⁠integer

    Default: 1

    Minimum: 1

    Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
  • per_page ⁠integer

    Minimum: 1

    How many items to display per page.
  • refundable ⁠string

    One of: "true", "false"

    Filter the list by slots that are refundable
  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
  • sort_by ⁠string

    One of: "refund_expires_at", "-refund_expires_at"

    Default: "refund_expires_at"

    Used to specify how you want the results sorted.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Headers

• • Total-Count ⁠integer
    Total number of items.

  Optional

  • Link ⁠string
    Links to next and last page.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • autorenew ⁠object
      Status of autorenew on the slot, may be false if there is no active autorenew

      With the following properties:

      • duration_month ⁠integer

        One of: 1, 12

        Duration in months to be used for autorenewal
      • sharing_id ⁠string
        Sharing who paid for this autorenewal process
    • config ⁠object
      Information on the configuration applied to this slot

      With the following properties:

      • label ⁠string
        Commercial label of configuration
      • name ⁠string
        Internal name of configuration
      • uuid ⁠string
        Config id
    • expires_at ⁠datetime
      When the slot expires
    • last_paid_duration ⁠integer

      One of: 1, 12

      Duration of last paid renewal
    • refund_info ⁠object
      Information about the refundable process, may be false if there no refundable possibility

      With the following properties:

      • currency ⁠string
        Refund currency
      • price ⁠number
        Refund amout
      • refund_expires_at ⁠datetime
        This is the date on which refund is possible
    • refundable ⁠boolean
      If this slot can be refundable
    • uuid ⁠string
      Slot id
  Example:

  [
    {
      "uuid": "5156f881-cf33-11ee-aa2a-c889f3cdfda1",
      "autorenew": {
        "duration_month": 12,
        "sharing_id": "5156f881-cf33-11ee-aa2a-c000f3cdfda8"
      },
      "config": {
        "label": "Premium 50 Go",
        "name": "premium-50go",
        "uuid": "5156f876-cf33-11ee-aa4a-c889f3cdfda7"
      },
      "expires_at": "2024-03-20T14:29:41Z",
      "last_paid_duration": 1,
      "refund_info": {
        "currency": "EUR",
        "price": 61.8,
        "refund_expires_at": "2025-03-04T14:29:41Z"
      },
      "refundable": true
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string