Mailbox API (BETA version)

Query String

• Optional

  • 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.

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

• • Filtered-Count ⁠integer
    Number of items returned by the API call.
  • 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:

    • fqdns ⁠array

      Of items of type:

      • Values of types:
    • owner ⁠object

      With the following properties:

      • id ⁠string
        UUID's owner
      • name ⁠string
        Owner's name
  Example:

  []

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

• • domain ⁠string
    The domain

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:

  • antispam ⁠boolean
  • configuration ⁠array

    Of items of type:

    • object

      With the following properties:

      • key ⁠string
      • values ⁠array[ string ]
  • dkim ⁠boolean
  • internal ⁠boolean
  • is_livedns ⁠boolean
  • mx ⁠boolean
  • spf ⁠boolean
  • txt ⁠boolean

  Optional

  • date_last_validation ⁠datetime
  Example - Domain details and configuration for DNS records.:

  {
    "dkim": false,
    "mx": false,
    "spf": false,
    "txt": false,
    "internal": false,
    "antispam": false,
    "is_livedns": false,
    "configuration": [
      {
        "key": "TXT",
        "values": [
          "mailsa 10800 IN TXT \"03c77e4fabebde501d83d55cd937671a6a3760d9aa4b2e0fe47f754dc4fa213f\""
        ]
      },
      {
        "key": "DKIM",
        "values": [
          "gm1._domainkey 1200 IN CNAME gm1.gandimail.net.",
          "gm2._domainkey 1200 IN CNAME gm2.gandimail.net.",
          "gm3._domainkey 1200 IN CNAME gm3.gandimail.net."
        ]
      }
    ]
  }

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

• • domain ⁠string
    The domain

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

  • records_to_validate ⁠array[ string ]
    List of elements to validate
  Example - Validate DNS records.:

  {
    "records_to_validate": [
      "dkim",
      "spf",
      "txt"
    ]
  }

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

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

  • destinations ⁠array[ string ]
    A list of email addresses.
  • source ⁠string
    The source email address.
  Example:

  {
    "source": "alice@gandi.net",
    "destinations": [
      "alice.doe@example.org",
      "ruth@example.org"
    ]
  }

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

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

  • 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.
  • search ⁠string
    Filter the list by source or destination.
    Example: lice@mydomain
    Example: alice
    Example: domain.com
  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
  • sort_by ⁠string

    One of: "source", "-source"

    Default: "source"

    Result sorting field.

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

• • X-Total-Count ⁠integer
    Total number of items after filtering.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • destinations ⁠string
      email addresses to forward emails to.
    • source ⁠string
      The source email address.

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

• • source ⁠string

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

  • destinations ⁠array[ string ]
    A list of email addresses.
  Example:

  {
    "destinations": [
      "alice@example.org",
      "hello.world@gandi.net"
    ]
  }

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

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

• • source ⁠string

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:

  • 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

Body

• application/json

  ⁠object

  With the following properties:

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

Query String

• Optional

  • address ⁠string
    Filter by exact login
    Example: alice
  • domain_part ⁠string
    Filter by exact fqdn
    Example: mydomain.com
  • local_part ⁠string
    Filter by exact login
    Example: alice
  • 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.
  • search ⁠string
    Search by login, complete email or domain name.
    Example: lice@mydomain
    Example: alice
    Example: domain.com
  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
  • sort_by ⁠string

    One of: "id", "-id", "local_part", "-local_part", "config_name", "-config_name", "expire_at", "-expire_at", "quota", "-quota", "autorenew", "-autorenew"

    Default: "id"

    Result sorting field.

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

• • X-Total-Count ⁠integer
    Total number of items after filtering.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • address ⁠string
      Complete address of mailbox
    • antispam ⁠boolean
      Antispam is enabled
    • config ⁠object
      Mailbox configuration

      With the following properties:

      • label ⁠string
        Label of configuration
      • name ⁠string
        Technical name of configuration
      • quota_kb ⁠integer
        Quota in Kb
      • uuid ⁠string
        Configuration ID
    • created_at ⁠datetime
      Creation date
    • data_access ⁠boolean
      Information about access
    • domain_part ⁠string
      Domain name
    • expires_at ⁠datetime
      Expiry date
    • internal_domain ⁠boolean
      Information about internal domain
    • last_paid_duration ⁠integer
      Duration of last subscription
    • local_part ⁠string
      Mailbox login
    • owner ⁠object
      Information about owner

      With the following properties:

      • id ⁠string
        UUID's owner
      • name ⁠string
        Owner's name
    • quota ⁠integer
      Quota allowed
    • quota_used ⁠integer
      Quota used
    • updated_at ⁠datetime
      Updated date
    • uuid ⁠string
      Mailbox ID

    Optional

    • autorenew ⁠object
      Object with info about autorenew, can be null

      With the following properties:

      • duration ⁠integer

        One of: 1, 12

        Duration for renew
      • duration_type ⁠string

        One of: "m", "y"

        Month or Year for renewal duration
      • sharing_id ⁠string
        Organization will be billed
    • issues ⁠array[ string ]
      Array with potentials issues
    • responder ⁠object
      Information about responder's state

      With the following properties:

      • ends_at ⁠datetime
        Responder end date
      • message ⁠string
        Responder message
      • starts_at ⁠datetime
        Responder start date

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
    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.
  • duration_month ⁠integer

    One of: 1, 12

    The duration of the subscription 1 or 12 month(s).
  Example - Create a mailbox standard for mensual subscription:

  {
    "duration_month": 1,
    "config_name": "standard",
    "email": "hello@domain.com",
    "password": "fds678fdsDdsç!è"
  }

  Example - Create a mailbox premium for annual subscription:

  {
    "duration_month": 12,
    "config_name": "premium",
    "email": "premium@domain.com",
    "password": "4f56&dsqf4s"
  }

  Example - Create a mailbox with aliases.:

  {
    "duration_month": 12,
    "config_name": "premium",
    "email": "hi@domain.com",
    "password": "4f56&dsqf4s",
    "aliases": [
      "contact",
      "redir"
    ]
  }

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:

  • address ⁠string
    Complete address of mailbox
  • antispam ⁠boolean
    Antispam is enabled
  • config ⁠object
    Mailbox configuration

    With the following properties:

    • label ⁠string
      Label of configuration
    • name ⁠string
      Technical name of configuration
    • quota_kb ⁠integer
      Quota in Kb
    • uuid ⁠string
      Configuration ID
  • created_at ⁠datetime
    Creation date
  • data_access ⁠boolean
    Information about access
  • domain_part ⁠string
    Domain name
  • expires_at ⁠datetime
    Expiry date
  • internal_domain ⁠boolean
    Information about internal domain
  • last_paid_duration ⁠integer
    Duration of last subscription
  • local_part ⁠string
    Mailbox login
  • owner ⁠object
    Information about owner

    With the following properties:

    • id ⁠string
      UUID's owner
    • name ⁠string
      Owner's name
  • quota ⁠integer
    Quota allowed
  • quota_used ⁠integer
    Quota used
  • updated_at ⁠datetime
    Updated date
  • uuid ⁠string
    Mailbox ID

  Optional

  • aliases ⁠array[ string ]
    secondary emails of a mailbox
  • autorenew ⁠object
    Object with info about autorenew, can be null

    With the following properties:

    • duration ⁠integer

      One of: 1, 12

      Duration for renew
    • duration_type ⁠string

      One of: "m", "y"

      Month or Year for renewal duration
    • sharing_id ⁠string
      Organization will be billed
  • issues ⁠array
    Array with potentials issues
  • responder ⁠object
    Information about responder's state

    With the following properties:

    • ends_at ⁠datetime
      Responder end date
    • message ⁠string
      Responder message
    • starts_at ⁠datetime
      Responder start date

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

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:

  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.
  • antispam ⁠boolean

    Default: true

    Enable or disable antispam.
  • autorenew ⁠object

    With the following properties:

    Required

    • activated ⁠boolean
      Specify true to enable autorenew, false to disable it.
    • duration ⁠integer

      One of: 1, 12

      Duration for autorenew in month(s).
  • config_name ⁠string

    One of: "standard", "premium"

    You can change the offer of your mailbox updating your config_name it can be standard (10GB) or premium (50 GB).
  • password ⁠string

    Minimum length: 8

    Maximum length: 200

    Update your password : Minimum length: 8 Maximum length: 200 Mailbox password.

    Must contain between 8 and 200 characters, containing at least 1 upper-case letter, 3 numbers, and a special character.

    You can also send a hashed password in SHA512-CRYPT ie: $6$xxxx$yyyy

  • responder ⁠object

    With the following properties:

    Required

    • activated ⁠boolean

      Default: false

      ⁠default false / true is the responder is activated

    Optional

    • ends_at ⁠datetime
      responder end date
    • message ⁠string
      responder message
    • starts_at ⁠datetime
      responder start date
  Example - Update mailbox password:

  {
    "password": "xXXXxx4f56&dsqf4sXXxx"
  }

  Example - Change offer to premium:

  {
    "config_name": "premium"
  }

  Example - Change offer to standard:

  {
    "config_name": "standard"
  }

  Example - Enable automatic responder:

  {
    "responder": {
      "activated": true,
      "starts_at": "2025-04-20T09:00:00Z",
      "ends_at": "2025-05-07T19:00:00Z",
      "message": "Out of office"
    }
  }

  Example - Disable automatic responder:

  {
    "responder": {
      "activated": false
    }
  }

  Example - Update aliases:

  {
    "aliases": [
      "hello",
      "contact"
    ]
  }

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

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

  Optional

  • Dry-Run ⁠integer
    If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • duration ⁠integer
    The duration (in month) of the renewal.
  Example - Renewal for 1 month:

  {
    "duration": 1
  }

  Example - Renewal for 12 months:

  {
    "duration": 12
  }

Headers

• Optional

  • Warning ⁠string
    Warning message

Body

• application/json

  ⁠object

  With the following properties:

  • status ⁠string

    One of: "success", "error"

    Response status.

  Optional

  • errors ⁠array
    A list of all the errors encountered during validation.

    Of items of type:

    • object

      With the following properties:

      • description ⁠string
        Error message.
      • location ⁠string

        One of: "header", "path", "querystring", "body"

        The field's location in the HTTP response.
      • name ⁠string
        The xpath of the field.

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

  • 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.
  Example - buy 2 standard mailboxes with mensual subscription:

  {
    "config_name": "standard",
    "duration_month": 1,
    "quantity": 2
  }

  Example - buy premium mailbox with annual subscription and activate autorenew:

  {
    "config_name": "premium",
    "duration_month": 12,
    "quantity": 1,
    "autorenew": true
  }

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

  • 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

Headers

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

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • config ⁠array
      List config apply to this product

      Of items of type:

      • object

        With the following properties:

        • label ⁠string
        • name ⁠string
        • uuid ⁠string
          UUID
    • config_name ⁠string
    • description ⁠string
    • label ⁠string
    • prices ⁠array
      List of prices

      Of items of type:

      • object

        With the following properties:

        • currency ⁠string
        • duration_unit ⁠string
        • max_duration ⁠integer
        • min_duration ⁠integer
        • normal_price_after_taxes ⁠number
        • normal_price_before_taxes ⁠number
        • price_after_taxes ⁠number
        • price_before_taxes ⁠number
    • taxes ⁠array
      List of taxes

      Of items of type:

      • object

        With the following properties:

        • name ⁠string
          Tax name
        • name_label ⁠string
          Tax name label
        • rate ⁠number
          Rate value
        • type ⁠string
    • uuid ⁠string
      Product id

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

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • annually ⁠object
      Quota for mailboxes paid in annually subscription.

      With the following properties:

      • available ⁠integer
        The count of mailboxes available to create mailbox.
      • total ⁠integer
        The total represents mailboxes available to create mailbox and mailbox already used.
      • used ⁠integer
        The count of mailboxes already used.
    • config_name ⁠string
      Configuration name of the mailbox.
    • label ⁠string
      Label of the offer.
    • monthly ⁠object
      Quota for mailboxes paid in monthly subscription.

      With the following properties:

      • available ⁠integer
        The count of mailboxes available to create mailbox.
      • total ⁠integer
        The total represents mailboxes available to create mailbox and mailbox already used.
      • used ⁠integer
        The count of mailboxes already used.
    • quota ⁠string
      Quota of the mailbox expressed in giga byte (GB).
  Example:

  [
    {
      "annually": {
        "available": 0,
        "total": 1,
        "used": 1
      },
      "config_name": "standard",
      "label": "Standard 10Gb",
      "monthly": {
        "available": 1,
        "total": 1,
        "used": 0
      },
      "quota": "10Gb"
    },
    {
      "annually": {
        "available": 1,
        "total": 3,
        "used": 2
      },
      "config_name": "premium",
      "label": "Premium 50Gb",
      "monthly": {
        "available": 0,
        "total": 0,
        "used": 0
      },
      "quota": "50Gb"
    }
  ]

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.
  • webhosting_pack ⁠boolean
    Filter the list by slot linked to a webhosting pack

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

• • Filtered-Count ⁠integer
    Number of items returned by the API call.
  • 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:

    • 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
    • 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
    • webhosting_pack ⁠boolean
      If this slot is linked to a webhosting pack

    Optional

    • 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
    • expires_at ⁠datetime
      When the slot expires
    • last_paid_duration ⁠integer

      One of: 1, 12

      Duration of last paid renewal
  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,
      "webhosting_pack": false
    }
  ]

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

• • slot_id ⁠string
    Identifier of the slot, an uuid.

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:

  • 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
  • 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
  • webhosting_pack ⁠boolean
    If this slot is linked to a webhosting pack

  Optional

  • 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
  • expires_at ⁠datetime
    When the slot expires
  • last_paid_duration ⁠integer

    One of: 1, 12

    Duration of last paid renewal

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