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.
Authorization
Bearer JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.
In: header
Path Parameters
The network whose agent should serve the environment's contacts.
uuidThe environment (account) whose contacts to enroll.
uuidThe tenant identifier
The transport connection to actuate and the enroll/offboard flag.
The integration connection whose transport to actuate (e.g. the customer's TexterChat config).
uuidtrue to enroll (the network's agent answers), false to offboard / roll back.
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
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}Gets one periodic sync policy by id.
Returns the stated policy — config, cadence, and whether the sweep also enrolls — together with the bookkeeping that says whether it is running: last enqueue, the run it produced, the next due time, and the reason the last tick failed if it did. Pair it with `GET directory/importRuns?scheduleId={id}` for the full history of what this schedule has done.
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.