Skip to content

by Startups.Studio

Growth Conversation

Conversation.assign

POST /{namespace}/conversations/{conversation}/assign

Assign routes a Conversation to the Worker holding the right Role, by topic, Customer tier and language.

Noun: Conversation
Mode: do
Event: Conversation.assigned

You, to your agent

Assign the latest conversation.

curl -X POST https://api.sb/kilnbakery.com/conversations/conversation_1/assign \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const conversation = await $.Conversation.assign({ conversation: 'conversation_1' })

npx startup-builder do Conversation.assign --json '{"conversation":"conversation_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Conversation.assign({ conversation: 'conversation_1' })"
  }
}

Inputs

Input	Type	Required	Description
`conversation`	Conversation	required	The Conversation to route.
`worker`	Worker		The Worker to take it; omitted, the routing Policy picks.

Outputs

Output	Type	Required	Description
`conversation`	Conversation	required	The Conversation, with its Worker.

Effects

Emits Conversation.assigned.
Performed by the Customer Lead.
Two-way: it runs at once, in the try, send and do modes.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Conversation.assign

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Conversation.answer

Previous Page

Conversation.close

Next Page