POST/v1/conversations/{conversation_id}/tagsbeta

Tag a conversation

Needs: Manage conversations: notes, assign, close, tags, reminders (inbox:write)
Plan: Any plan with API access
Limits: 60 a minute per key
Dry run: Yes — every check runs with ?dry_run=true, nothing changes
Undo: Remove them with Untag a conversation (a tag created by name stays in the workspace).

Adds conversation tags by id and/or name; the conversation keeps its other tags, and adding a tag it already has changes nothing, so a retry is harmless. A name that does not exist yet creates a new conversation tag in the workspace. Unknown ids are skipped and listed in ignored_tag_ids.

Conversation tags are separate from contact tags.

Try it

Path

conversation_idrequiredstring

The conversation id.

Edit as JSON

tag_idsoptionallist

Existing conversation tag ids.

tag_namesoptionallist

Tag names (1–50 characters). A new name creates the tag.

Idempotency-Keyoptional — made for you if empty

Protects against doing it twice if you retry: a retry with the same key gets the first answer back instead of running again.

Test mode (dry run): nothing will change

Run liveTurns test mode off for this page only. It switches back when you leave the page.

curl -X POST 'https://mcp.wa-api.cloud/v1/conversations/77410/tags?dry_run=true' \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "tag_names": [
    "urgent"
  ]
}'

The code reads your key from $API_KEY.

Parameters

Parameters
Field	Type	What it is
conversation_idrequired	string · path	The conversation id.pattern `^\d{1,19}$`Signed in? Pick one from your data with “My data”.

Body

Body fields
Field	Type	What it is
tag_ids	array of string	Existing conversation tag ids.0–20 items
tag_names	array of string	Tag names (1–50 characters). A new name creates the tag.0–20 items

Headers

Headers
Field	Type	What it is
Authorizationrequired	header	`Bearer $API_KEY` — your API key.
Api-Version	header	The API version to use, e.g. `2026-10-01`. Default: the version your key is pinned to.one of: `2026-10-01` · pattern `^\d{4}-\d{2}-\d{2}$`
Idempotency-Key	header	Any unique string (8–128 characters). A retry with the same key returns the first answer instead of running twice. Kept 24 hours.pattern `^[A-Za-z0-9._:-]+$` · 8–128 characters

Response `200`

The conversation with all its tags.

Response fields
Field	Type	What it is
conversationrequired	object
idrequired	string
staterequired	string or null
assignee_staff_idrequired	string or null
team_idrequired	string or null
tagsrequired	array of object
idrequired	string
namerequired	string
ignored_tag_idsrequired	array of string
dry_run	boolean	`true` when this was a dry run: every check ran and nothing changed.

Errors

Errors are application/problem+json. Branch on code.

Status	Code	When
400	invalid_input	A field is missing or has the wrong format. `errors[]` points at each field. Neither `tag_ids` nor `tag_names` was given (up to 20 each).
401	unauthenticated	The Authorization header is missing, the key is unknown, expired or revoked.
403	entitlement_required	The workspace's plan does not include API access (`api_access`).
403	insufficient_scope	The key does not have the permission this operation needs.
404	not_found	No conversation with this id.
409	conflict	Also returned while a request with the same Idempotency-Key is still running.
429	rate_limited	The key or workspace went over its rate limit. Wait for `Retry-After` seconds.
503	upstream_unavailable	A service behind the API is briefly unavailable. Safe to retry with backoff.
504	timeout	The change did not finish in time. Retry with the same Idempotency-Key: it never runs twice.

Examples

Flag a conversation as urgent

Request body

{
  "tag_names": [
    "urgent"
  ]
}

Response 200

{
  "conversation": {
    "id": "77410",
    "state": "open",
    "assignee_staff_id": null,
    "team_id": null,
    "tags": [
      {
        "id": "4",
        "name": "new-lead"
      },
      {
        "id": "7",
        "name": "urgent"
      }
    ]
  },
  "ignored_tag_ids": []
}

Operation path

The same operation is also at POST /v1/ops/inbox_tag_conversation, with every field in the JSON body.