FruxonDocs
Agent NetworkParticipants

Patches the consult-roster metadata on one participant↔agent binding.

PATCH semantics: null fields are left unchanged; a supplied list replaces the stored one. `default_for_roles` must be a subset of `roles`. The `binding` route segment is the agent id (consistent with the bind sub-resource). 404 if the binding doesn't exist.

PATCH
/v1/tenants/{tenant}/participants/{participant}/bindings/{binding}/roster

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

participant*string

The participant identifier.

Formatuuid
binding*string

The agent identifier whose binding to patch.

tenant*string

The tenant identifier

Request Body

The roster patch.

roles?|null

Replacement expertise tags, e.g. ["ux", "on-call"]. Null leaves them unchanged.

maxUrgency?string

Cap on proposable urgency. Null leaves it unchanged.

Value in"UNSPECIFIED" | "LOW" | "NORMAL" | "HIGH" | "EMERGENCY"
defaultForRoles?|null

Roles for which this participant is the preferred pick. Null leaves them unchanged.

responsePolicy?string

When this binding's agent should respond to inbound messages from the participant. ALWAYS (default) fires on every inbound; WHEN_ADDRESSED fires only on direct messages, @-mentions of the bot, or replies to the bot. Null leaves the current policy unchanged.

Value in"UNSPECIFIED" | "ALWAYS" | "WHEN_ADDRESSED" | "RELEVANCE" | "MUTED"
venueBrief?string|null

Optional length-limited group-specific scope note for relevance checks, such as "react only to delivery incidents". Null leaves the existing value unchanged; a non-null value replaces it, and empty or whitespace clears it.

Length0 <= length <= 280
[key: string]?never

Response Body

curl -X PATCH "https://api.fruxon.com/v1/tenants/string/participants/497f6eca-6276-4993-bfeb-53cbbbba6f08/bindings/string/roster" \  -H "Content-Type: application/json" \  -d '{}'
{
  "participantId": "00000000-0000-0000-0000-000000000000",
  "agentId": "string",
  "displayName": "string",
  "kind": "PERSON",
  "avatarFileId": "string",
  "roles": [
    "string"
  ],
  "routableRoles": [
    "string"
  ],
  "consultAllowed": false,
  "maxUrgency": "LOW",
  "defaultForRoles": [
    "string"
  ],
  "responsePolicy": "ALWAYS",
  "venueBrief": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Adds (or returns the existing) binding between the participant and an agent.

Binds the participant to an agent so the agent can address it. The call is idempotent: if the binding already exists it is returned unchanged rather than duplicated. Returns 404 when the participant does not exist.

Lists an agent's consult roster — its bound participants with consult metadata.

Returns one row per participant bound to `agentId`, each with its consult-roster settings (roles, consult allowed, urgency cap, default for roles) that drive `consult_for_role` resolution and the consult policy.