Resend API (unofficial showcase)
PATCH/inboxes/{inbox_id}/agent

Update inbox agent settings

Updates the agent settings for an inbox, creating an agent if one is not configured. Provide at least one of instructions, tone, or enabled_actions; omitted fields keep their current values.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
inbox_idstringrequired
The UUID of the inbox whose agent settings to update; an email address is not accepted.

Provide at least one agent setting to update. Omitted fields keep their current values.

instructionsstringrequired
Instructions the agent follows when it handles the threads of the inbox. Max 4000 characters. Leading and trailing whitespace is trimmed, and the trimmed value must not be empty. Send null to clear the instructions.
tonestringoptional
The tone the agent writes in. Send null to clear the tone.
Allowed:concise_professionalconcise_casualexpanded_professionalexpanded_casualnull
enabled_actionsarray<string>optional
The actions the agent can take. Replaces the whole set. Duplicates are removed. Send an empty array to disable all actions.

1 status code
200Returns the inbox agent object type and its ID.
objectstringrequired
The object type. Always `inbox_agent`.
idstringrequired
The ID of the inbox agent.

Error handling

The inbox_id path parameter must be a UUID identifying an inbox. Provide at least one of instructions, tone, or enabled_actions; string instructions must contain 1 to 4000 characters, tone must be concise_professional, concise_casual, expanded_professional, expanded_casual, or null, and each action must be draft_reply, forward_thread, add_labels, assign_thread, mark_as_spam, archive_thread, or delete_thread.