Commune icon

Commune

Send and receive emails, manage inboxes, and search conversations with Commune

Actions14

Inbox → Update

AI-generated

Summary

Update an inbox's display name and/or agent name on the Commune platform

Inputs

  • domainId (required) — The ID of the domain the inbox belongs to
  • inboxId (required) — The ID of the inbox to act on
  • inboxUpdateOptions — Fields to update on the inbox. At least one field must be provided

Output shape

json

The API response data, unwrapped from any { data: } envelope

Examples

Example 1: Update inbox display name and agent name

domainId provided, inboxId provided, inboxUpdateOptions contains displayName and/or agentName

Links

Discussion