ArgorantDocs

Change the tags of an order's mailboxes

posthttps://app.argorant.com/api/v1/inboxes/orders/{order_id}/tags
POST
/api/v1/inboxes/orders/{order_id}/tags

Tags to add.

Tags to take off.

Change the tags an order gives its mailboxes. Every mailbox the order already created changes at once, and mailboxes it creates later get the new tags too. An order keeps up to 10 tags.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists

Authorization

BearerAuth
AuthorizationBearer <token>

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

Path Parameters

order_id*string

The order id.

Formatuuid

Header Parameters

Idempotency-Key?string

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.

Lengthlength <= 128
X-Request-Id?string

Your 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.

Match^[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

Shell
curl -X POST "https://app.argorant.com/api/v1/inboxes/orders/b345aa96-059d-47e7-b733-c1899f843a00/tags" \  -H "Idempotency-Key: 6f1c2e7a-run-42" \  -H "Content-Type: application/json" \  -d '{    "add": [      "Q4 push"    ],    "remove": [      "Test"    ]  }'
JSON
{  "order_id": "b345aa96-059d-47e7-b733-c1899f843a00",  "tags": [    "Q4 push"  ],  "mailboxes_changed": 100,  "note": "Mailboxes this order still creates get these tags too."}