Organizations

Change the settings for members' agents

Changed on

Changes any subset of how members' agents work. Policy fields (on/off, working hours, daily limit, members' starting choice, default destination: a Workbot DM or nowhere, never a channel) apply from the next pass; members' own choices (muted, snoozed, turned off, their own destination) are kept. sources sets what agents may read: calendar, email, chat and connections by connection id, each everyone (on for everyone), members (members choose; null also means this) or off (not allowed). sources.coreConnections.{calendar,email,chat} picks which of the organization's connections serve that source (ids from sourceConnections; null goes back to every connection that serves it), so a member's other accounts on the same service are never read or asked for. Members can never read a source the admin didn't allow or turn off one that is on for everyone. A change to responsibilities or instructions saves a new version of the organization's "Your agent" template. Agents only read and never send, edit or delete anything for members. Requires the workbotProactive feature, Workbot on this deployment and Manage OpenWork Models.

put/v1/org/workbot-settings/proactive

Request

  • Base URL
    https://api.openworklabs.com
  • URL
    https://api.openworklabs.com/v1/org/workbot-settings/proactive
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Request body

enabledboolean
leadMinutesinteger
workingDays'weekdays' | 'everyday'
startHourinteger
endHourinteger
dailyCapinteger
membersStart'opted_in' | 'opted_out'
destination'workbot_dm' nullable
instructionsstring

Response

Agent settings saved.

slackReadyboolean required
runnerReadyboolean required

Changes

    • info

      added the new optional request property /

    • info

      added the optional property // to the response with the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status