Tag many mailboxes
Add and remove tags on many mailboxes in one call. Choose them by address, domain, tag, status or order_id (every mailbox one order created), or every mailbox with status: "any". The first call is a preview that changes nothing; send preview: false to change them. A mailbox keeps at most 30 tags.
| Cost | What it does | Key scopes |
|---|---|---|
| Free | Writes | argorant:manage_lists |
Authorization
BearerAuth Your API key from app.argorant.com/profile, sent as Authorization: Bearer <key>. A connector sign-in token (ag_mcp_...) works the same way.
In: header
Header Parameters
Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.
length <= 128Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.
^[A-Za-z0-9._-]{8,64}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://app.argorant.com/api/v1/inboxes/tags" \ -H "Idempotency-Key: 6f1c2e7a-run-42" \ -H "Content-Type: application/json" \ -d '{ "order_id": "b345aa96-059d-47e7-b733-c1899f843a00", "add": [ "Q4 push" ], "preview": false }'{ "matched": 200, "would_change": 200, "already_set": 0, "changed": 200, "add": [ "Q4 push" ], "remove": [], "preview": false, "summary_text": "Changed 200 mailbox(es) (add \"Q4 push\")."}