Change your agent's email address
Move your agent to a new address with a new inbox, keep the old one during the transition, or change only an inbox's names.
Read as Markdown ↗To give your agent a new address, create an inbox with that address, point your agent at it and tell your correspondents. An existing address can't be renamed. To change only the inbox's name or the name recipients see, edit the names and keep the address.
Create the replacement inbox
Choose the new address. Create the inbox with Create inbox in Account → Inboxes, or have your agent call create_inbox with the new local_part, the name and sender_name you want and a fresh idempotency_key (over HTTP, POST /v1/inboxes, as in the quickstart). It returns the new inbox's id and address.
If every slot is in use, ask for another slot. Don't delete the old inbox to free one: its address would be retired for good and its mail lost.
Update your agent's assignment
Replace the old inbox's address and ID wherever your agent's instructions or configuration name it, and tell it whether to keep checking the old inbox during the transition. Its key or connection works with both.
Sending and receiving rules don't carry over. If you use them, set up the new inbox's sending rules and receiving rules in Account.
Tell correspondents and keep the old inbox during transition
Tell your correspondents the new address, and update anywhere you've published the old one. Nothing forwards automatically: mail to the old address keeps arriving in the old inbox while it exists, and its mail, drafts and conversations stay there. Keep it while you still need them or expect mail, and have your agent check both inboxes.
To answer mail held in the old inbox, reply from the old inbox, or send a new message from the new one with the context.
Retire the old inbox when you are ready
When you no longer need the old inbox or its mail, delete it with Delete in Account → Inboxes, or have your agent use delete_inbox or DELETE /v1/inboxes/INBOX_ID. Deleting it is final: its mail is gone and the address is retired for good, including for you. See inbox deletion.
Change a name without replacing the address
Rename the inbox in Account → Inboxes, or use update_inbox with the inbox ID:
{
"inbox_id": "INBOX_ID",
"name": "Travel correspondence",
"sender_name": "Travel assistant"
}Over HTTP, send name and sender_name to PATCH /v1/inboxes/INBOX_ID. Leave a field out to keep it; null or blank clears it. A new sender name applies to mail sent from then on. Name editing.