Skip to main content
PATCH
Inboxes are currently in private beta and only available to a limited number of users. The response shape might change before GA.Get early access if you’re interested in testing this feature.Once you have access, upgrade your Resend SDK to use the new methods:

Path Parameters

Body Parameters

Send at least one of instructions, tone, or actions. Omitted fields keep their current value.
string | null
Instructions the agent follows when handling the inbox’s threads. 1 to 4000 characters. Whitespace at the start and end does not count. Send null to clear them.
'concise_professional' | 'concise_casual' | 'expanded_professional' | 'expanded_casual' | null
Tone the agent writes in. Send null to clear it.
  • concise_professional: Brief responses in a professional tone.
  • concise_casual: Brief responses in a casual tone.
  • expanded_professional: Detailed responses in a professional tone.
  • expanded_casual: Detailed responses in a casual tone.
string[]
Actions the agent is allowed to take. The list replaces the current actions. Send an empty array to disable all actions.
  • draft_reply: Draft a reply.
  • forward_thread: Forward a thread.
  • add_labels: Add labels to a thread.
  • assign_thread: Assign a thread.
  • mark_as_spam: Mark a thread as spam.
  • archive: Archive a thread.
  • move_to_trash: Move a thread to the trash.

Response Fields

string
Always inbox_agent.
string
The ID of the agent.