# Web Cloud › Email and Collaborative Solutions › Zimbra › Accounts API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Web Cloud product's sections: https://developers.eu.ovhcloud.com/reference/web-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 5 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/web-cloud/email-and-collaborative-solutions/zimbra/accounts/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/web-cloud/email-and-collaborative-solutions/zimbra/accounts.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/web-cloud/email-and-collaborative-solutions/zimbra/accounts.json?format=openapi3

## Operations

- `GET /zimbra/platform/{platformId}/account` — List email accounts
- `GET /zimbra/platform/{platformId}/account/{accountId}` — Get an email account
- `POST /zimbra/platform/{platformId}/account` — Create an email account
- `DELETE /zimbra/platform/{platformId}/account/{accountId}` — Delete an email account
- `PUT /zimbra/platform/{platformId}/account/{accountId}` — Update an email account

## List email accounts

`GET /v2/zimbra/platform/{platformId}/account`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/email-and-collaborative-solutions/zimbra/accounts/#get-zimbra-platform-platformid-account

**Status:** Stable production version  
**IAM actions:** `zimbra:apiovh:platform/account/get`

Returns the email accounts of the platform with their current state. Filter them by `organizationId`, `organizationLabel`, `domainId`, `email` or `offer`.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `domainId` | query | string (uuid) |  | Filter by Domain identifier |
| `email` | query | string |  | Filter by email |
| `offer` | query | zimbra.OfferEnum |  | Filter by offer — one of `PRO`, `STARTER` |
| `organizationId` | query | string (uuid) |  | Filter by organization identifier |
| `organizationLabel` | query | string |  | Filter by organization label |
| `platformId` | path | string (uuid) | yes | Platform ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | zimbra.AccountResponse[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Checksum hash in MD5 representation |
| `currentState` | zimbra.AccountCurrentState | read-only | Object representing account |
| `currentState.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `currentState.contactInformation.city` | string |  | City of the account user |
| `currentState.contactInformation.company` | string |  | Company name of the account user |
| `currentState.contactInformation.country` | string |  | Company name of the account user |
| `currentState.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `currentState.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `currentState.contactInformation.office` | string |  | Office location of the account user |
| `currentState.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `currentState.contactInformation.postcode` | string |  | Postal code of the account user |
| `currentState.contactInformation.profession` | string |  | Profession of the account user |
| `currentState.contactInformation.service` | string |  | Department of the account user |
| `currentState.contactInformation.street` | string |  | Street name of the account user |
| `currentState.createdAt` | string (date-time) | read-only | Date of creation |
| `currentState.description` | string | read-only | Description of the account |
| `currentState.detailedStatus` | zimbra.AccountDetailedStatus[] | read-only | Breakdown of what the account is doing, giving the reason behind its overall status |
| `currentState.detailedStatus[].details` | string | read-only | Further details if the code is not sufficient |
| `currentState.detailedStatus[].link` | string | read-only | A link to a document that provides more information on the status |
| `currentState.detailedStatus[].status` | zimbra.AccountStatusEnum | read-only | Current account status — one of `BILLINGLOCKED`, `BLOCKEDFORSPAM` |
| `currentState.displayName` | string | read-only | Display name of the account |
| `currentState.domainId` | string (uuid) | read-only | Domain ID related to the account |
| `currentState.email` | string | read-only | Email address of the account |
| `currentState.firstName` | string | read-only | First name of the account user |
| `currentState.hideInGal` | boolean | read-only | Whether to hide email address in GAL or not |
| `currentState.lastConnectionAt` | string (date-time) | read-only | Last connection date |
| `currentState.lastName` | string | read-only | Last name of the account user |
| `currentState.offer` | zimbra.OfferEnum | read-only | Offer of the account — one of `PRO`, `STARTER` |
| `currentState.organizationId` | string (uuid) | read-only | ID of the organization to which the account belongs |
| `currentState.organizationLabel` | string | read-only | Label of the organization to which the account belongs |
| `currentState.quota` | zimbra.Quota | read-only | Maximum account capacity |
| `currentState.quota.additional` | number | read-only | Space included in account additions |
| `currentState.quota.available` | number | read-only | Remaining space |
| `currentState.quota.limit` | number | read-only | User defined maximum space for account |
| `currentState.quota.maximum` | number | read-only | Total space for account |
| `currentState.quota.offer` | number | read-only | Space included in account offer |
| `currentState.quota.used` | number | read-only | Space already taken |
| `currentState.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |
| `currentState.slotId` | string (uuid) | read-only | Slot id of the account |
| `currentState.updatedAt` | string (date-time) | read-only | Date of update |
| `currentTasks` | common.CurrentTask[] | read-only | An array containing tasks responses pending on resource extends AsyncResourceBase object |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Resource identifier in UUID representation |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Current resource status — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | zimbra.AccountTargetSpec | read-only | Object representing account |
| `targetSpec.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `targetSpec.contactInformation.city` | string |  | City of the account user |
| `targetSpec.contactInformation.company` | string |  | Company name of the account user |
| `targetSpec.contactInformation.country` | string |  | Company name of the account user |
| `targetSpec.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `targetSpec.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `targetSpec.contactInformation.office` | string |  | Office location of the account user |
| `targetSpec.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `targetSpec.contactInformation.postcode` | string |  | Postal code of the account user |
| `targetSpec.contactInformation.profession` | string |  | Profession of the account user |
| `targetSpec.contactInformation.service` | string |  | Department of the account user |
| `targetSpec.contactInformation.street` | string |  | Street name of the account user |
| `targetSpec.description` | string | read-only | Description of the account |
| `targetSpec.displayName` | string | read-only | Display name of the account |
| `targetSpec.email` | string | read-only | Email address of the account |
| `targetSpec.firstName` | string | read-only | First name of the account user |
| `targetSpec.hideInGal` | boolean | read-only | Whether email address should be hidden in GAL |
| `targetSpec.lastName` | string | read-only | Last name of the account user |
| `targetSpec.quota` | zimbra.QuotaPayload | read-only | Number representation of account capacity |
| `targetSpec.quota.limit` | number |  | Maximum space for account |
| `targetSpec.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |

```json
[
  {
    "checksum": "string",
    "currentState": {
      "contactInformation": {
        "city": "string",
        "company": "string",
        "country": "string",
        "faxNumber": "string",
        "mobileNumber": "string",
        "office": "string",
        "phoneNumber": "string",
        "postcode": "string",
        "profession": "string",
        "service": "string",
        "street": "string"
      },
      "createdAt": "2024-01-01T12:00:00Z",
      "description": "string",
      "detailedStatus": [
        {
          "details": "string",
          "link": "string",
          "status": "BILLINGLOCKED"
        }
      ],
      "displayName": "string",
      "domainId": "00000000-0000-0000-0000-000000000000",
      "email": "string",
      "firstName": "string",
      "hideInGal": true,
      "lastConnectionAt": "2024-01-01T12:00:00Z",
      "lastName": "string",
      "offer": "PRO",
      "organizationId": "00000000-0000-0000-0000-000000000000",
      "organizationLabel": "string",
      "quota": {
        "additional": 0,
        "available": 0,
        "limit": 0,
        "maximum": 0,
        "offer": 0,
        "used": 0
      },
      "quotaRefreshedAt": "2024-01-01T12:00:00Z",
      "slotId": "00000000-0000-0000-0000-000000000000",
      "updatedAt": "2024-01-01T12:00:00Z"
    },
    "currentTasks": [
      {
        "errors": [
          {
            "message": "string"
          }
        ],
        "id": "00000000-0000-0000-0000-000000000000",
        "link": "string",
        "status": "ERROR",
        "type": "string"
      }
    ],
  …
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/account" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/zimbra/platform/{platformId}/account")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/zimbra/platform/{platformId}/account");

print_r($result);
?>
```

## Get an email account

`GET /v2/zimbra/platform/{platformId}/account/{accountId}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/email-and-collaborative-solutions/zimbra/accounts/#get-zimbra-platform-platformid-account-accountid

**Status:** Stable production version  
**IAM actions:** `zimbra:apiovh:platform/account/get`

Returns the email address, offer, slot, quota usage, contact information and detailed status of the email account, with its ongoing tasks.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `accountId` | path | string (uuid) | yes | Account ID |
| `platformId` | path | string (uuid) | yes | Platform ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | zimbra.AccountResponse | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Checksum hash in MD5 representation |
| `currentState` | zimbra.AccountCurrentState | read-only | Object representing account |
| `currentState.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `currentState.contactInformation.city` | string |  | City of the account user |
| `currentState.contactInformation.company` | string |  | Company name of the account user |
| `currentState.contactInformation.country` | string |  | Company name of the account user |
| `currentState.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `currentState.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `currentState.contactInformation.office` | string |  | Office location of the account user |
| `currentState.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `currentState.contactInformation.postcode` | string |  | Postal code of the account user |
| `currentState.contactInformation.profession` | string |  | Profession of the account user |
| `currentState.contactInformation.service` | string |  | Department of the account user |
| `currentState.contactInformation.street` | string |  | Street name of the account user |
| `currentState.createdAt` | string (date-time) | read-only | Date of creation |
| `currentState.description` | string | read-only | Description of the account |
| `currentState.detailedStatus` | zimbra.AccountDetailedStatus[] | read-only | Breakdown of what the account is doing, giving the reason behind its overall status |
| `currentState.detailedStatus[].details` | string | read-only | Further details if the code is not sufficient |
| `currentState.detailedStatus[].link` | string | read-only | A link to a document that provides more information on the status |
| `currentState.detailedStatus[].status` | zimbra.AccountStatusEnum | read-only | Current account status — one of `BILLINGLOCKED`, `BLOCKEDFORSPAM` |
| `currentState.displayName` | string | read-only | Display name of the account |
| `currentState.domainId` | string (uuid) | read-only | Domain ID related to the account |
| `currentState.email` | string | read-only | Email address of the account |
| `currentState.firstName` | string | read-only | First name of the account user |
| `currentState.hideInGal` | boolean | read-only | Whether to hide email address in GAL or not |
| `currentState.lastConnectionAt` | string (date-time) | read-only | Last connection date |
| `currentState.lastName` | string | read-only | Last name of the account user |
| `currentState.offer` | zimbra.OfferEnum | read-only | Offer of the account — one of `PRO`, `STARTER` |
| `currentState.organizationId` | string (uuid) | read-only | ID of the organization to which the account belongs |
| `currentState.organizationLabel` | string | read-only | Label of the organization to which the account belongs |
| `currentState.quota` | zimbra.Quota | read-only | Maximum account capacity |
| `currentState.quota.additional` | number | read-only | Space included in account additions |
| `currentState.quota.available` | number | read-only | Remaining space |
| `currentState.quota.limit` | number | read-only | User defined maximum space for account |
| `currentState.quota.maximum` | number | read-only | Total space for account |
| `currentState.quota.offer` | number | read-only | Space included in account offer |
| `currentState.quota.used` | number | read-only | Space already taken |
| `currentState.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |
| `currentState.slotId` | string (uuid) | read-only | Slot id of the account |
| `currentState.updatedAt` | string (date-time) | read-only | Date of update |
| `currentTasks` | common.CurrentTask[] | read-only | An array containing tasks responses pending on resource extends AsyncResourceBase object |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Resource identifier in UUID representation |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Current resource status — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | zimbra.AccountTargetSpec | read-only | Object representing account |
| `targetSpec.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `targetSpec.contactInformation.city` | string |  | City of the account user |
| `targetSpec.contactInformation.company` | string |  | Company name of the account user |
| `targetSpec.contactInformation.country` | string |  | Company name of the account user |
| `targetSpec.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `targetSpec.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `targetSpec.contactInformation.office` | string |  | Office location of the account user |
| `targetSpec.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `targetSpec.contactInformation.postcode` | string |  | Postal code of the account user |
| `targetSpec.contactInformation.profession` | string |  | Profession of the account user |
| `targetSpec.contactInformation.service` | string |  | Department of the account user |
| `targetSpec.contactInformation.street` | string |  | Street name of the account user |
| `targetSpec.description` | string | read-only | Description of the account |
| `targetSpec.displayName` | string | read-only | Display name of the account |
| `targetSpec.email` | string | read-only | Email address of the account |
| `targetSpec.firstName` | string | read-only | First name of the account user |
| `targetSpec.hideInGal` | boolean | read-only | Whether email address should be hidden in GAL |
| `targetSpec.lastName` | string | read-only | Last name of the account user |
| `targetSpec.quota` | zimbra.QuotaPayload | read-only | Number representation of account capacity |
| `targetSpec.quota.limit` | number |  | Maximum space for account |
| `targetSpec.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |

```json
{
  "checksum": "string",
  "currentState": {
    "contactInformation": {
      "city": "string",
      "company": "string",
      "country": "string",
      "faxNumber": "string",
      "mobileNumber": "string",
      "office": "string",
      "phoneNumber": "string",
      "postcode": "string",
      "profession": "string",
      "service": "string",
      "street": "string"
    },
    "createdAt": "2024-01-01T12:00:00Z",
    "description": "string",
    "detailedStatus": [
      {
        "details": "string",
        "link": "string",
        "status": "BILLINGLOCKED"
      }
    ],
    "displayName": "string",
    "domainId": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "firstName": "string",
    "hideInGal": true,
    "lastConnectionAt": "2024-01-01T12:00:00Z",
    "lastName": "string",
    "offer": "PRO",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "organizationLabel": "string",
    "quota": {
      "additional": 0,
      "available": 0,
      "limit": 0,
      "maximum": 0,
      "offer": 0,
      "used": 0
    },
    "quotaRefreshedAt": "2024-01-01T12:00:00Z",
    "slotId": "00000000-0000-0000-0000-000000000000",
    "updatedAt": "2024-01-01T12:00:00Z"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "contactInformation": {
  …
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/account/{accountId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/zimbra/platform/{platformId}/account/{accountId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/zimbra/platform/{platformId}/account/{accountId}");

print_r($result);
?>
```

## Create an email account

`POST /v2/zimbra/platform/{platformId}/account`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/email-and-collaborative-solutions/zimbra/accounts/#post-zimbra-platform-platformid-account

**Status:** Stable production version  
**IAM actions:** `zimbra:apiovh:platform/account/create`

Creates an email account from its `email`, `password`, `offer` and `slotId`. The domain must be ready and the slot must match the offer. Creation is asynchronous: follow `resourceStatus` and `currentTasks`.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `platformId` | path | string (uuid) | yes | Platform ID |

### Request body (required)

Type: `zimbra.AccountPostPayload`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `targetSpec` | zimbra.AccountPostTargetSpec | yes | Target organization specification |
| `targetSpec.contactInformation` | zimbra.ContactInformation |  | Object representing contact information which extends account object |
| `targetSpec.contactInformation.city` | string |  | City of the account user |
| `targetSpec.contactInformation.company` | string |  | Company name of the account user |
| `targetSpec.contactInformation.country` | string |  | Company name of the account user |
| `targetSpec.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `targetSpec.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `targetSpec.contactInformation.office` | string |  | Office location of the account user |
| `targetSpec.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `targetSpec.contactInformation.postcode` | string |  | Postal code of the account user |
| `targetSpec.contactInformation.profession` | string |  | Profession of the account user |
| `targetSpec.contactInformation.service` | string |  | Department of the account user |
| `targetSpec.contactInformation.street` | string |  | Street name of the account user |
| `targetSpec.description` | string |  | Description of the account |
| `targetSpec.displayName` | string |  | Display name of the account |
| `targetSpec.email` | string | yes | Email address of the account |
| `targetSpec.firstName` | string |  | First name of the account user |
| `targetSpec.forceChangePasswordAfterLogin` | boolean |  | Force a change password after user logs into webmail |
| `targetSpec.hideInGal` | boolean |  | Whether email address should be hidden in GAL |
| `targetSpec.lastName` | string |  | Last name of the account user |
| `targetSpec.offer` | zimbra.OfferEnum | yes | Offer type of the account — one of `PRO`, `STARTER` |
| `targetSpec.password` | string (password) | yes | Password of the account |
| `targetSpec.quota` | zimbra.QuotaPayload |  | Number representation of account capacity |
| `targetSpec.quota.limit` | number |  | Maximum space for account |
| `targetSpec.slotId` | string (uuid) | yes | Slot ID to be linked to the account |

```json
{
  "targetSpec": {
    "contactInformation": {
      "city": "string",
      "company": "string",
      "country": "string",
      "faxNumber": "string",
      "mobileNumber": "string",
      "office": "string",
      "phoneNumber": "string",
      "postcode": "string",
      "profession": "string",
      "service": "string",
      "street": "string"
    },
    "description": "string",
    "displayName": "string",
    "email": "string",
    "firstName": "string",
    "forceChangePasswordAfterLogin": true,
    "hideInGal": true,
    "lastName": "string",
    "offer": "PRO",
    "password": "string",
    "quota": {
      "limit": 0
    },
    "slotId": "00000000-0000-0000-0000-000000000000"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | zimbra.AccountResponse | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Checksum hash in MD5 representation |
| `currentState` | zimbra.AccountCurrentState | read-only | Object representing account |
| `currentState.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `currentState.contactInformation.city` | string |  | City of the account user |
| `currentState.contactInformation.company` | string |  | Company name of the account user |
| `currentState.contactInformation.country` | string |  | Company name of the account user |
| `currentState.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `currentState.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `currentState.contactInformation.office` | string |  | Office location of the account user |
| `currentState.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `currentState.contactInformation.postcode` | string |  | Postal code of the account user |
| `currentState.contactInformation.profession` | string |  | Profession of the account user |
| `currentState.contactInformation.service` | string |  | Department of the account user |
| `currentState.contactInformation.street` | string |  | Street name of the account user |
| `currentState.createdAt` | string (date-time) | read-only | Date of creation |
| `currentState.description` | string | read-only | Description of the account |
| `currentState.detailedStatus` | zimbra.AccountDetailedStatus[] | read-only | Breakdown of what the account is doing, giving the reason behind its overall status |
| `currentState.detailedStatus[].details` | string | read-only | Further details if the code is not sufficient |
| `currentState.detailedStatus[].link` | string | read-only | A link to a document that provides more information on the status |
| `currentState.detailedStatus[].status` | zimbra.AccountStatusEnum | read-only | Current account status — one of `BILLINGLOCKED`, `BLOCKEDFORSPAM` |
| `currentState.displayName` | string | read-only | Display name of the account |
| `currentState.domainId` | string (uuid) | read-only | Domain ID related to the account |
| `currentState.email` | string | read-only | Email address of the account |
| `currentState.firstName` | string | read-only | First name of the account user |
| `currentState.hideInGal` | boolean | read-only | Whether to hide email address in GAL or not |
| `currentState.lastConnectionAt` | string (date-time) | read-only | Last connection date |
| `currentState.lastName` | string | read-only | Last name of the account user |
| `currentState.offer` | zimbra.OfferEnum | read-only | Offer of the account — one of `PRO`, `STARTER` |
| `currentState.organizationId` | string (uuid) | read-only | ID of the organization to which the account belongs |
| `currentState.organizationLabel` | string | read-only | Label of the organization to which the account belongs |
| `currentState.quota` | zimbra.Quota | read-only | Maximum account capacity |
| `currentState.quota.additional` | number | read-only | Space included in account additions |
| `currentState.quota.available` | number | read-only | Remaining space |
| `currentState.quota.limit` | number | read-only | User defined maximum space for account |
| `currentState.quota.maximum` | number | read-only | Total space for account |
| `currentState.quota.offer` | number | read-only | Space included in account offer |
| `currentState.quota.used` | number | read-only | Space already taken |
| `currentState.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |
| `currentState.slotId` | string (uuid) | read-only | Slot id of the account |
| `currentState.updatedAt` | string (date-time) | read-only | Date of update |
| `currentTasks` | common.CurrentTask[] | read-only | An array containing tasks responses pending on resource extends AsyncResourceBase object |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Resource identifier in UUID representation |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Current resource status — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | zimbra.AccountTargetSpec | read-only | Object representing account |
| `targetSpec.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `targetSpec.contactInformation.city` | string |  | City of the account user |
| `targetSpec.contactInformation.company` | string |  | Company name of the account user |
| `targetSpec.contactInformation.country` | string |  | Company name of the account user |
| `targetSpec.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `targetSpec.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `targetSpec.contactInformation.office` | string |  | Office location of the account user |
| `targetSpec.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `targetSpec.contactInformation.postcode` | string |  | Postal code of the account user |
| `targetSpec.contactInformation.profession` | string |  | Profession of the account user |
| `targetSpec.contactInformation.service` | string |  | Department of the account user |
| `targetSpec.contactInformation.street` | string |  | Street name of the account user |
| `targetSpec.description` | string | read-only | Description of the account |
| `targetSpec.displayName` | string | read-only | Display name of the account |
| `targetSpec.email` | string | read-only | Email address of the account |
| `targetSpec.firstName` | string | read-only | First name of the account user |
| `targetSpec.hideInGal` | boolean | read-only | Whether email address should be hidden in GAL |
| `targetSpec.lastName` | string | read-only | Last name of the account user |
| `targetSpec.quota` | zimbra.QuotaPayload | read-only | Number representation of account capacity |
| `targetSpec.quota.limit` | number |  | Maximum space for account |
| `targetSpec.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |

```json
{
  "checksum": "string",
  "currentState": {
    "contactInformation": {
      "city": "string",
      "company": "string",
      "country": "string",
      "faxNumber": "string",
      "mobileNumber": "string",
      "office": "string",
      "phoneNumber": "string",
      "postcode": "string",
      "profession": "string",
      "service": "string",
      "street": "string"
    },
    "createdAt": "2024-01-01T12:00:00Z",
    "description": "string",
    "detailedStatus": [
      {
        "details": "string",
        "link": "string",
        "status": "BILLINGLOCKED"
      }
    ],
    "displayName": "string",
    "domainId": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "firstName": "string",
    "hideInGal": true,
    "lastConnectionAt": "2024-01-01T12:00:00Z",
    "lastName": "string",
    "offer": "PRO",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "organizationLabel": "string",
    "quota": {
      "additional": 0,
      "available": 0,
      "limit": 0,
      "maximum": 0,
      "offer": 0,
      "used": 0
    },
    "quotaRefreshedAt": "2024-01-01T12:00:00Z",
    "slotId": "00000000-0000-0000-0000-000000000000",
    "updatedAt": "2024-01-01T12:00:00Z"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "contactInformation": {
  …
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/account" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: zimbra.AccountPostPayload
result = client.post("/v2/zimbra/platform/{platformId}/account",
	targetSpec = None, # Target organization specification (type: zimbra.AccountPostTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: zimbra.AccountPostPayload
$result = $ovh->post("/v2/zimbra/platform/{platformId}/account", array(
	targetSpec => null, // Target organization specification (type: zimbra.AccountPostTargetSpec)
));

print_r($result);
?>
```

## Delete an email account

`DELETE /v2/zimbra/platform/{platformId}/account/{accountId}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/email-and-collaborative-solutions/zimbra/accounts/#delete-zimbra-platform-platformid-account-accountid

**Status:** Stable production version  
**IAM actions:** `zimbra:apiovh:platform/account/delete`

Deletes the email account. An account blocked for spam cannot be deleted.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `accountId` | path | string (uuid) | yes | Account ID |
| `platformId` | path | string (uuid) | yes | Platform ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/account/{accountId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/v2/zimbra/platform/{platformId}/account/{accountId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/v2/zimbra/platform/{platformId}/account/{accountId}");

print_r($result);
?>
```

## Update an email account

`PUT /v2/zimbra/platform/{platformId}/account/{accountId}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/email-and-collaborative-solutions/zimbra/accounts/#put-zimbra-platform-platformid-account-accountid

**Status:** Stable production version  
**IAM actions:** `zimbra:apiovh:platform/account/edit`

Updates the email address, password, names, contact information, visibility in the global address list (`hideInGal`) or quota limit of the email account. When set, `checksum` must match the current checksum of the account, otherwise the update is rejected.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `accountId` | path | string (uuid) | yes | Account ID |
| `platformId` | path | string (uuid) | yes | Platform ID |

### Request body (required)

Type: `zimbra.AccountPutPayload`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string |  | Known checksum of the resource, allowing to prevent unwanted side effects |
| `targetSpec` | zimbra.AccountPutTargetSpec | yes | Target account specification |
| `targetSpec.contactInformation` | zimbra.ContactInformation |  | Object representing contact information which extends account object |
| `targetSpec.contactInformation.city` | string |  | City of the account user |
| `targetSpec.contactInformation.company` | string |  | Company name of the account user |
| `targetSpec.contactInformation.country` | string |  | Company name of the account user |
| `targetSpec.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `targetSpec.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `targetSpec.contactInformation.office` | string |  | Office location of the account user |
| `targetSpec.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `targetSpec.contactInformation.postcode` | string |  | Postal code of the account user |
| `targetSpec.contactInformation.profession` | string |  | Profession of the account user |
| `targetSpec.contactInformation.service` | string |  | Department of the account user |
| `targetSpec.contactInformation.street` | string |  | Street name of the account user |
| `targetSpec.description` | string |  | Description of the account |
| `targetSpec.displayName` | string |  | Display name of the account |
| `targetSpec.email` | string |  | Email address of the account |
| `targetSpec.firstName` | string |  | First name of the account user |
| `targetSpec.forceChangePasswordAfterLogin` | boolean |  | Force a change password after user logs into webmail |
| `targetSpec.hideInGal` | boolean |  | Whether email address should be hidden in GAL |
| `targetSpec.lastName` | string |  | Last name of the account user |
| `targetSpec.password` | string |  | Password of the account |
| `targetSpec.quota` | zimbra.QuotaPayload |  | Number representation of account capacity |
| `targetSpec.quota.limit` | number |  | Maximum space for account |
| `targetSpec.quotaRefreshedAt` | string (date-time) |  | Datetime of last quota refresh |

```json
{
  "checksum": "string",
  "targetSpec": {
    "contactInformation": {
      "city": "string",
      "company": "string",
      "country": "string",
      "faxNumber": "string",
      "mobileNumber": "string",
      "office": "string",
      "phoneNumber": "string",
      "postcode": "string",
      "profession": "string",
      "service": "string",
      "street": "string"
    },
    "description": "string",
    "displayName": "string",
    "email": "string",
    "firstName": "string",
    "forceChangePasswordAfterLogin": true,
    "hideInGal": true,
    "lastName": "string",
    "password": "string",
    "quota": {
      "limit": 0
    },
    "quotaRefreshedAt": "2024-01-01T12:00:00Z"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | zimbra.AccountResponse | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |
| 412 | object | Error 412 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Checksum hash in MD5 representation |
| `currentState` | zimbra.AccountCurrentState | read-only | Object representing account |
| `currentState.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `currentState.contactInformation.city` | string |  | City of the account user |
| `currentState.contactInformation.company` | string |  | Company name of the account user |
| `currentState.contactInformation.country` | string |  | Company name of the account user |
| `currentState.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `currentState.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `currentState.contactInformation.office` | string |  | Office location of the account user |
| `currentState.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `currentState.contactInformation.postcode` | string |  | Postal code of the account user |
| `currentState.contactInformation.profession` | string |  | Profession of the account user |
| `currentState.contactInformation.service` | string |  | Department of the account user |
| `currentState.contactInformation.street` | string |  | Street name of the account user |
| `currentState.createdAt` | string (date-time) | read-only | Date of creation |
| `currentState.description` | string | read-only | Description of the account |
| `currentState.detailedStatus` | zimbra.AccountDetailedStatus[] | read-only | Breakdown of what the account is doing, giving the reason behind its overall status |
| `currentState.detailedStatus[].details` | string | read-only | Further details if the code is not sufficient |
| `currentState.detailedStatus[].link` | string | read-only | A link to a document that provides more information on the status |
| `currentState.detailedStatus[].status` | zimbra.AccountStatusEnum | read-only | Current account status — one of `BILLINGLOCKED`, `BLOCKEDFORSPAM` |
| `currentState.displayName` | string | read-only | Display name of the account |
| `currentState.domainId` | string (uuid) | read-only | Domain ID related to the account |
| `currentState.email` | string | read-only | Email address of the account |
| `currentState.firstName` | string | read-only | First name of the account user |
| `currentState.hideInGal` | boolean | read-only | Whether to hide email address in GAL or not |
| `currentState.lastConnectionAt` | string (date-time) | read-only | Last connection date |
| `currentState.lastName` | string | read-only | Last name of the account user |
| `currentState.offer` | zimbra.OfferEnum | read-only | Offer of the account — one of `PRO`, `STARTER` |
| `currentState.organizationId` | string (uuid) | read-only | ID of the organization to which the account belongs |
| `currentState.organizationLabel` | string | read-only | Label of the organization to which the account belongs |
| `currentState.quota` | zimbra.Quota | read-only | Maximum account capacity |
| `currentState.quota.additional` | number | read-only | Space included in account additions |
| `currentState.quota.available` | number | read-only | Remaining space |
| `currentState.quota.limit` | number | read-only | User defined maximum space for account |
| `currentState.quota.maximum` | number | read-only | Total space for account |
| `currentState.quota.offer` | number | read-only | Space included in account offer |
| `currentState.quota.used` | number | read-only | Space already taken |
| `currentState.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |
| `currentState.slotId` | string (uuid) | read-only | Slot id of the account |
| `currentState.updatedAt` | string (date-time) | read-only | Date of update |
| `currentTasks` | common.CurrentTask[] | read-only | An array containing tasks responses pending on resource extends AsyncResourceBase object |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Resource identifier in UUID representation |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Current resource status — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | zimbra.AccountTargetSpec | read-only | Object representing account |
| `targetSpec.contactInformation` | zimbra.ContactInformation | read-only | Object representing contact information which extends account object |
| `targetSpec.contactInformation.city` | string |  | City of the account user |
| `targetSpec.contactInformation.company` | string |  | Company name of the account user |
| `targetSpec.contactInformation.country` | string |  | Company name of the account user |
| `targetSpec.contactInformation.faxNumber` | string |  | Fax number of the account user |
| `targetSpec.contactInformation.mobileNumber` | string |  | Mobile number of the account user |
| `targetSpec.contactInformation.office` | string |  | Office location of the account user |
| `targetSpec.contactInformation.phoneNumber` | string |  | Phone number of the account user |
| `targetSpec.contactInformation.postcode` | string |  | Postal code of the account user |
| `targetSpec.contactInformation.profession` | string |  | Profession of the account user |
| `targetSpec.contactInformation.service` | string |  | Department of the account user |
| `targetSpec.contactInformation.street` | string |  | Street name of the account user |
| `targetSpec.description` | string | read-only | Description of the account |
| `targetSpec.displayName` | string | read-only | Display name of the account |
| `targetSpec.email` | string | read-only | Email address of the account |
| `targetSpec.firstName` | string | read-only | First name of the account user |
| `targetSpec.hideInGal` | boolean | read-only | Whether email address should be hidden in GAL |
| `targetSpec.lastName` | string | read-only | Last name of the account user |
| `targetSpec.quota` | zimbra.QuotaPayload | read-only | Number representation of account capacity |
| `targetSpec.quota.limit` | number |  | Maximum space for account |
| `targetSpec.quotaRefreshedAt` | string (date-time) | read-only | Datetime of last quota refresh |

```json
{
  "checksum": "string",
  "currentState": {
    "contactInformation": {
      "city": "string",
      "company": "string",
      "country": "string",
      "faxNumber": "string",
      "mobileNumber": "string",
      "office": "string",
      "phoneNumber": "string",
      "postcode": "string",
      "profession": "string",
      "service": "string",
      "street": "string"
    },
    "createdAt": "2024-01-01T12:00:00Z",
    "description": "string",
    "detailedStatus": [
      {
        "details": "string",
        "link": "string",
        "status": "BILLINGLOCKED"
      }
    ],
    "displayName": "string",
    "domainId": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "firstName": "string",
    "hideInGal": true,
    "lastConnectionAt": "2024-01-01T12:00:00Z",
    "lastName": "string",
    "offer": "PRO",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "organizationLabel": "string",
    "quota": {
      "additional": 0,
      "available": 0,
      "limit": 0,
      "maximum": 0,
      "offer": 0,
      "used": 0
    },
    "quotaRefreshedAt": "2024-01-01T12:00:00Z",
    "slotId": "00000000-0000-0000-0000-000000000000",
    "updatedAt": "2024-01-01T12:00:00Z"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "contactInformation": {
  …
```

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/account/{accountId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: zimbra.AccountPutPayload
result = client.put("/v2/zimbra/platform/{platformId}/account/{accountId}",
	checksum = None, # Known checksum of the resource, allowing to prevent unwanted side effects (type: string)
	targetSpec = None, # Target account specification (type: zimbra.AccountPutTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: zimbra.AccountPutPayload
$result = $ovh->put("/v2/zimbra/platform/{platformId}/account/{accountId}", array(
	checksum => null, // Known checksum of the resource, allowing to prevent unwanted side effects (type: string)
	targetSpec => null, // Target account specification (type: zimbra.AccountPutTargetSpec)
));

print_r($result);
?>
```