FruxonDocs
Agent NetworkParticipants

Enrolls or off-boards one contact into a network's agent.

Grants the contact Served access in the network with the agent switch on (or flips it off on offboard), then actuates their transport — for TexterChat, recovers the chat from their most recent inbound and flips `externalBot`. A contact who has never messaged is enrolled but reported without a channel to actuate yet. Reversible — pass `enabled=false` to roll back.

POST
/v1/tenants/{tenant}/networks/{network}/participants/{participant}:enroll
AuthorizationBearer <token>

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

In: header

Path Parameters

network*string

The network whose agent should serve the contact.

Formatuuid
participant*string

The contact to enroll.

Formatuuid
tenant*string

The tenant identifier

The transport connection to actuate and the enroll/offboard flag.

integrationConfigId?string

The integration connection whose transport to actuate (e.g. the customer's TexterChat config).

Formatuuid
enabled?boolean

true to enroll (the network's agent answers), false to offboard / roll back.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/networks/497f6eca-6276-4993-bfeb-53cbbbba6f08/participants/497f6eca-6276-4993-bfeb-53cbbbba6f08:enroll" \  -H "Content-Type: application/json" \  -d '{}'
{
  "enabled": false,
  "participantsEnrolled": 0,
  "channelsActuated": 0,
  "contactsWithoutChannel": 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
}