Tags
A tag is your own key and value on a record, such as {"team": "billing"}. Resia stores tags as you send them and never interprets them. Use them to group records and to filter lists.
Where you set tags |
Notes |
|---|---|
| Call Agents, Orchestration Agents, Chat Agents, knowledge bases, API keys | Set on create. On a PUT, tags that you leave out are cleared, like any other optional field. |
| Calls, chats, and orchestration runs | Set on POST /v1/calls, POST /v1/chats, and POST /v1/orchestration-runs. A chat that a person starts by text has no tags. |
| Call batches and text message batches | Copied onto every call or text the batch creates. |
| Phone numbers | Set with PATCH /v1/phone-numbers/{phone_number}. The map replaces all of the number's tags. Send {} or null to remove them. Leave the field out to keep them. |
Every tag value is a string. To filter a list, send tag_key and tag_value together. Resia refuses one without the other with 422. A list returns only the records whose tags hold that exact pair. These lists accept the filter: GET /v1/calls, GET /v1/chats, GET /v1/call-batches, GET /v1/orchestration-runs, GET /v1/text-messages, GET /v1/text-message-batches, GET /v1/call-agents, GET /v1/orchestration-agents, GET /v1/chat-agents, GET /v1/knowledge-bases, GET /v1/phone-numbers, and the API key list.
Do not put names, phone numbers, or any personal, health, credential, or secret information in a tag. A tag travels in the URL when you filter by it, and URLs appear in ordinary request logs.
