Users

Change my agent

Changed on

Changes the signed-in member's own agent, as they would say it: turn it on or off (on), snooze it until the next working morning or resume (snooze: "tomorrow" or null), stop or restart one kind of message (mute / unmute: morning_brief, meeting_prep, calendar_changes, waiting_on_you). With My agent on (workbotAgentLibrary) also: what they want in their own words (preferences.always, .never, .when, .how; plain text, an empty string clears one), narrower working hours (hours: {startHour, endHour}, null for the admin's), a lower daily limit (dailyCap, null for the admin's), hours inside the day when only urgent messages go out (quietWindow: {startHour, endHour}, null removes it), and undo: "last" reverts the member's last save, a change id reverts one change (send undo on its own). For "between 12 and 2 only urgent stuff, stop telling me about calendar changes" send preferences.when, quietWindow 12–14 and mute calendar_changes in one call. A member can only narrow the admin's limits: wider hours or a higher limit answer 400 limit_wider_than_admin with a message to relay. The response's saved.reply says exactly what was saved, "Reply "undo" to revert." and the link to My agent: reply with it as is, in plain text. Organization settings and limits still apply. Requires the workbotProactive feature and Workbot on this deployment.

put/v1/me/agent

Request

  • Base URL
    https://api.openworklabs.com
  • URL
    https://api.openworklabs.com/v1/me/agent
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Request body

onboolean
snooze'tomorrow' nullable
mutestring[]
unmutestring[]
dailyCapinteger nullable
undostring

Response

The member's agent after the change.

availableboolean required
onboolean required
snoozedUntilstring date-time nullable required
nextCheckAtstring date-time nullable required
timeZonestring
sentTodayinteger
linkstring

Changes

  • 9fa47a73a88eRevision changes
    • breaking

      the response property const value invalid_request was removed for the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

  • 2badfe0bc939Revision changes
    • info

      endpoint added