Update inbox
Updates one or more mutable fields on the inbox. Only the fields present in the request body are changed; all others remain unchanged.
Authorization
BearerAuth AuthorizationBearer <token>
API key passed as a Bearer token. Production keys start with
am_live_ and sandbox keys start with am_test_.
In: header
Path Parameters
slug*string
The unique slug identifier of the inbox.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://secureagentmail.com/api/v1/inboxes/string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "inb_abc123",
"slug": "support-bot",
"display_name": "Support Bot",
"address": "[email protected]",
"security_level": "guarded_send",
"status": "active",
"message_count": 142,
"created_at": "2026-01-15T08:30:00Z",
"updated_at": "2026-02-20T14:00:00Z"
}{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key.",
"status": 401
}
}{
"error": {
"code": "not_found",
"message": "The requested resource was not found.",
"status": 404
}
}{
"error": {
"code": "validation_error",
"message": "The 'slug' field is required and must be a valid identifier.",
"status": 422
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Please retry after 30 seconds.",
"status": 429
}
}