Skip to content
API PlatformDevelopers
PUT/v1/conversations/{conversation_id}/assignmentstable

Assign 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
Assign it back, or use Unassign a conversation.

Assigns a conversation to a staff member or a team — give exactly one of staff_id or team_id. It reassigns if someone already has it, unless you set only_if_unassigned.

The assignee must have access to the channel.

Try it

Path

The conversation id.

Body

Assign to this staff member.

Assign to this team (clears the staff assignee).

Refuse instead of reassigning.

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
Turns test mode off for this page only. It switches back when you leave the page.

Code and response

curl -X PUT 'https://mcp.wa-api.cloud/v1/conversations/77410/assignment?dry_run=true' \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "staff_id": "1203",
  "only_if_unassigned": true
}'

The code reads your key from $API_KEY.

Parameters

Parameters
FieldTypeWhat it is
conversation_idrequiredstring · pathThe conversation id.pattern ^\d{1,19}$Signed in? Pick one from your data with “My data”.

Body

Body fields
FieldTypeWhat it is
staff_idstringAssign to this staff member.pattern ^\d{1,19}$
team_idstringAssign to this team (clears the staff assignee).pattern ^\d{1,19}$
only_if_unassignedbooleanRefuse instead of reassigning.default false

Headers

Headers
FieldTypeWhat it is
AuthorizationrequiredheaderBearer $API_KEY — your API key.
Api-VersionheaderThe 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-KeyheaderAny 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 new assignment.

Response fields
FieldTypeWhat it is
conversationrequiredobject
idrequiredstring
staterequiredstring or null
assignee_staff_idrequiredstring or null
team_idrequiredstring or null
tagsrequiredarray of object
idrequiredstring
namerequiredstring
assigned_torequiredstring
dry_runbooleantrue when this was a dry run: every check ran and nothing changed.

Errors

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

StatusCodeWhen
400invalid_input

A field is missing or has the wrong format. errors[] points at each field.

401unauthenticated

The Authorization header is missing, the key is unknown, expired or revoked.

403entitlement_required

The workspace's plan does not include API access (api_access).

403forbidden

The assignee has no access to this channel or is disabled.

403insufficient_scope

The key does not have the permission this operation needs.

404not_found

No conversation with this id.

409conflict

Already assigned and only_if_unassigned is true. Also returned while a request with the same Idempotency-Key is still running.

429rate_limited

The key or workspace went over its rate limit. Wait for Retry-After seconds.

503upstream_unavailable

A service behind the API is briefly unavailable. Safe to retry with backoff.

504timeout

The change did not finish in time. Retry with the same Idempotency-Key: it never runs twice.

Examples

Give a new lead to a sales rep

Request body

{
  "staff_id": "1203",
  "only_if_unassigned": true
}

Response 200

{
  "conversation": {
    "id": "77410",
    "state": "open",
    "assignee_staff_id": "1203",
    "team_id": null,
    "tags": [
      {
        "id": "4",
        "name": "new-lead"
      }
    ]
  },
  "assigned_to": "Priya Nair"
}

Webhook events

These events can fire after this call. Subscribe an endpoint to hear about them.

Operation path

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