FruxonDocs
ApiConsult pins

Creates a consult pin

Pins a capability to an advisor. The capability is trimmed; `agentId` null/blank makes it a tenant-global default, otherwise it overrides for that one agent. A duplicate (same scope + capability, compared case-insensitively) yields `409 Conflict`; an unknown participant yields `400 Bad Request`. Returns the created pin with its generated id.

POST
/v1/tenants/{tenant}/consultPins

Authorization

Bearer
AuthorizationBearer <token>

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

In: header

Path Parameters

tenant*string

The tenant identifier

Request Body

The pin to create.

agentId?string|null

The agent this override applies to. Null/blank = a tenant-global default owner for the capability; a value scopes the override to that one agent (agent beats global).

capability?string|null

Capability name this pin resolves. Matched case-insensitively, trimmed on write.

participantId?string

The advisor participant the capability resolves to.

Formatuuid
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/consultPins" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "agentId": "string",
  "capability": "string",
  "participantId": "00000000-0000-0000-0000-000000000000",
  "createdAt": 0,
  "modifiedAt": 0
}
{
  "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
}