> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.

# Update Account

PATCH https://api.agentmail.to/v0/accounts/{account_id}/update
Content-Type: application/json

Updates one account. Set `status` to `disabled` to stop the inbox from
signing in at the provider again, or to `enabled` to re-enable it.
Idempotent: disabling an already disabled account keeps its original
`disabled_at`, and enabling an enabled account is a no-op.

Find the `account_id` with List Accounts. An account exists only after an
inbox's first sign-in at a provider, so it cannot be disabled in advance.
A disable applies to that inbox at that provider whichever sign-in key is
used: the provider's next authorization ends in `access_denied`, and a code
issued earlier is refused with `invalid_grant`. Access tokens already
issued stay valid until they expire, and the provider's own session is
unaffected.

Requires `account_update`, which sign-in keys (`type: public_key`) cannot
hold, so call this with a bearer API key. An account outside the key's
scope is a 404. A 409 means the account changed during the write; read it
again and retry.

Reference: https://agentmail.to/docs/api-reference/accounts/update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.agentmail.to` (prod, default)
- `https://x402.api.agentmail.to` (prod-x402)
- `https://mpp.api.agentmail.to` (prod-mpp)
- `https://api.agentmail.eu` (eu-prod)

## Request

### Path parameters

- `account_id` (UUID, required) — ID of account.

### Body (application/json)

This endpoint expects an object.

- `status` (enum, optional) — Status to set. `disabled` stops the inbox from signing in at the provider; `enabled` re-enables it. An enabled account reads back with no `status`.
  - Allowed values: `enabled`, `disabled`

## Response

### 200

- `account_id` (UUID, required) — ID of account.
- `provider_id` (UUID, required) — ID of provider.
- `inbox_id` (string, required) — The ID of the inbox.
- `pod_id` (string, required) — ID of pod.
- `organization_id` (string, required) — ID of organization.
- `first_signed_in_at` (datetime, required) — Time of first sign-in at provider.
- `last_signed_in_at` (datetime, required) — Time of most recent sign-in at provider.
- `sign_in_count` (integer, required) — Number of sign-ins at provider.
- `provider_name` (string, optional) — Display name of provider.
- `status` (enum, optional) — Present only while the account is disabled. Absent means the inbox may sign in.
  - Allowed values: `disabled`
- `disabled_at` (datetime, optional) — Time at which the account was disabled. Present only while `status` is `disabled`.

## Errors

### 400 Validation Error

- `name` (string, required) — Name of error.
- `errors` (any, required) — Validation errors. Each entry has a path and a message identifying the invalid field.
- `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text.
- `message` (string, optional) — Error message.
- `fix` (string, optional) — The concrete next action that resolves the error.
- `docs` (string, optional) — Link to the error reference entry for this code.

### 404 Not Found Error

- `name` (string, required) — Name of error.
- `message` (string, required) — Error message.
- `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text.
- `fix` (string, optional) — The concrete next action that resolves the error.
- `docs` (string, optional) — Link to the error reference entry for this code.

### 409 Conflict Error

- `name` (string, required) — Name of error.
- `message` (string, required) — Error message.
- `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text.
- `fix` (string, optional) — The concrete next action that resolves the error.
- `docs` (string, optional) — Link to the error reference entry for this code.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "account_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "inbox_id": "inbox_id",
  "pod_id": "pod_id",
  "organization_id": "organization_id",
  "first_signed_in_at": "2024-01-15T09:30:00Z",
  "last_signed_in_at": "2024-01-15T09:30:00Z",
  "sign_in_count": 1,
  "provider_name": "provider_name",
  "status": "disabled",
  "disabled_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update"

payload = {}
headers = {
    "Authorization": "Bearer <api_key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <api_key>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <api_key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <api_key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update")
  .header("Authorization", "Bearer <api_key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <api_key>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <api_key>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <api_key>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/accounts/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/update")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> AgentMail is an email API built for AI agents. Create inboxes, send and receive messages, manage threads, and handle webhooks programmatically.