Mailbox API
https://api.sandbox.gandi.net/v5/mailbox
Manage your mailboxes ¶
https://api.sandbox.gandi.net/v5/mailbox/mailboxes
post Create new mailbox ¶
config_name
could be standard (10GB) or premium (50 GB).Request
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- config_name ⁠stringSpecify 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:
- stringA 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.
- string
- config_name ⁠string
Responses
202
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string
Delete mailbox ¶
https://api.sandbox.gandi.net/v5/mailbox/mailboxes/{email}
delete Delete mailbox ¶
Request
URI Parameters
- email ⁠stringThe email address
- email ⁠string
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string
Responses
204
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string
Buy mailbox ¶
https://api.sandbox.gandi.net/v5/mailbox/products
post Buy new mailbox ¶
Request
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string
Body
application/json
⁠objectWith 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 ⁠integerThe quantity of slots to purchase.
Optional
- autorenew ⁠boolean
Default: false
true
to enable the autorenewal.
- config_name ⁠string
Responses
202
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string
Listing slots ¶
https://api.sandbox.gandi.net/v5/mailbox/slots
get Lists all your slots ¶
Request
Query String
Optional
- config_name ⁠stringFilter the list by configuration name
- expires_at_gte ⁠datetimeSlot expiration date.
- expires_at_lte ⁠datetimeSlot 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 ⁠stringSharing 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.
- config_name ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string
Responses
200
Headers
- Total-Count ⁠integerTotal number of items.
Optional
- Link ⁠stringLinks to next and last page.
- Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- autorenew ⁠objectStatus 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 ⁠stringSharing who paid for this autorenewal process
- duration_month ⁠integer
- config ⁠objectInformation on the configuration applied to this slot
With the following properties:
- label ⁠stringCommercial label of configuration
- name ⁠stringInternal name of configuration
- uuid ⁠stringConfig id
- label ⁠string
- expires_at ⁠datetimeWhen the slot expires
- last_paid_duration ⁠integer
One of: 1, 12
Duration of last paid renewal - refund_info ⁠objectInformation about the refundable process, may be false if there no refundable possibility
With the following properties:
- currency ⁠stringRefund currency
- price ⁠numberRefund amout
- refund_expires_at ⁠datetimeThis is the date on which refund is possible
- currency ⁠string
- refundable ⁠booleanIf this slot can be refundable
- uuid ⁠stringSlot id
- autorenew ⁠object
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 } ]
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
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
- Authorization ⁠string