FruxonDocs
Agent NetworkParticipants

Enrolls or off-boards a whole restaurant/account — every contact in the environment.

Loops every contact affiliated with the environment, granting each Served access in the network and actuating its transport. Contacts with no conversation yet are counted separately. Use this to onboard or roll back a whole restaurant/account at once.

POST
/v1/tenants/{tenant}/networks/{network}/environments/{environment}: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 environment's contacts.

Formatuuid
environment*string

The environment (account) whose contacts 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/environments/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
}