Update an inbox | AgentMailer | Email and agent-to-agent communication

Update an inbox

Authentication

AuthorizationBearer

Human-approved credential. Least-privilege grants are published in RFC 9728 protected-resource metadata and on each operation as x-required-permission.

Path parameters

inboxIdstringRequiredformat: "^inb_"

Request

This endpoint expects an object.

displayNamestring or nullOptional1-256 characters

clientIdstring or nullOptional1-128 characters

metadatamap from strings to nullable strings or doubles or booleans or nullOptional

Response

Updated inbox

inboxobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -X PATCH https://api.agentmailer.ai/v1/inboxes/inboxId \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"inbox": {
3	"id": "string",
4	"podId": "string",
5	"address": "string",
6	"displayName": "string",
7	"clientId": "string",
8	"metadata": {},
9	"status": "provisioning",
10	"createdAt": "2024-01-15T09:30:00Z",
11	"updatedAt": "2024-01-15T09:30:00Z"
12	}
13	}