curl --request PUT \
--url https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"enabled": true,
"leadMinutes": 0,
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"destination": "workbot_dm",
"sources": {
"otherConnections": [
"<string>"
],
"connections": {},
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": true,
"checkGateThreshold": 0.5,
"sendCheck": true,
"sendCheckThreshold": 0.5,
"responsibilities": {
"morning_brief": true,
"meeting_prep": true,
"calendar_changes": true,
"waiting_on_you": true
},
"instructions": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent"
payload = {
"enabled": True,
"leadMinutes": 0,
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"destination": "workbot_dm",
"sources": {
"otherConnections": ["<string>"],
"connections": {},
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": True,
"checkGateThreshold": 0.5,
"sendCheck": True,
"sendCheckThreshold": 0.5,
"responsibilities": {
"morning_brief": True,
"meeting_prep": True,
"calendar_changes": True,
"waiting_on_you": True
},
"instructions": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
leadMinutes: 0,
startHour: 11,
endHour: 12,
dailyCap: 5,
destination: 'workbot_dm',
sources: {otherConnections: ['<string>'], connections: {}, toolOverrides: {}},
brief: {checkEveryHours: 1, dailyCap: 5, extraChecksPerDay: 3, text: '<string>'},
checkGate: true,
checkGateThreshold: 0.5,
sendCheck: true,
sendCheckThreshold: 0.5,
responsibilities: {
morning_brief: true,
meeting_prep: true,
calendar_changes: true,
waiting_on_you: true
},
instructions: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'leadMinutes' => 0,
'startHour' => 11,
'endHour' => 12,
'dailyCap' => 5,
'destination' => 'workbot_dm',
'sources' => [
'otherConnections' => [
'<string>'
],
'connections' => [
],
'toolOverrides' => [
]
],
'brief' => [
'checkEveryHours' => 1,
'dailyCap' => 5,
'extraChecksPerDay' => 3,
'text' => '<string>'
],
'checkGate' => true,
'checkGateThreshold' => 0.5,
'sendCheck' => true,
'sendCheckThreshold' => 0.5,
'responsibilities' => [
'morning_brief' => true,
'meeting_prep' => true,
'calendar_changes' => true,
'waiting_on_you' => true
],
'instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent"
payload := strings.NewReader("{\n \"enabled\": true,\n \"leadMinutes\": 0,\n \"startHour\": 11,\n \"endHour\": 12,\n \"dailyCap\": 5,\n \"destination\": \"workbot_dm\",\n \"sources\": {\n \"otherConnections\": [\n \"<string>\"\n ],\n \"connections\": {},\n \"toolOverrides\": {}\n },\n \"brief\": {\n \"checkEveryHours\": 1,\n \"dailyCap\": 5,\n \"extraChecksPerDay\": 3,\n \"text\": \"<string>\"\n },\n \"checkGate\": true,\n \"checkGateThreshold\": 0.5,\n \"sendCheck\": true,\n \"sendCheckThreshold\": 0.5,\n \"responsibilities\": {\n \"morning_brief\": true,\n \"meeting_prep\": true,\n \"calendar_changes\": true,\n \"waiting_on_you\": true\n },\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"leadMinutes\": 0,\n \"startHour\": 11,\n \"endHour\": 12,\n \"dailyCap\": 5,\n \"destination\": \"workbot_dm\",\n \"sources\": {\n \"otherConnections\": [\n \"<string>\"\n ],\n \"connections\": {},\n \"toolOverrides\": {}\n },\n \"brief\": {\n \"checkEveryHours\": 1,\n \"dailyCap\": 5,\n \"extraChecksPerDay\": 3,\n \"text\": \"<string>\"\n },\n \"checkGate\": true,\n \"checkGateThreshold\": 0.5,\n \"sendCheck\": true,\n \"sendCheckThreshold\": 0.5,\n \"responsibilities\": {\n \"morning_brief\": true,\n \"meeting_prep\": true,\n \"calendar_changes\": true,\n \"waiting_on_you\": true\n },\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"leadMinutes\": 0,\n \"startHour\": 11,\n \"endHour\": 12,\n \"dailyCap\": 5,\n \"destination\": \"workbot_dm\",\n \"sources\": {\n \"otherConnections\": [\n \"<string>\"\n ],\n \"connections\": {},\n \"toolOverrides\": {}\n },\n \"brief\": {\n \"checkEveryHours\": 1,\n \"dailyCap\": 5,\n \"extraChecksPerDay\": 3,\n \"text\": \"<string>\"\n },\n \"checkGate\": true,\n \"checkGateThreshold\": 0.5,\n \"sendCheck\": true,\n \"sendCheckThreshold\": 0.5,\n \"responsibilities\": {\n \"morning_brief\": true,\n \"meeting_prep\": true,\n \"calendar_changes\": true,\n \"waiting_on_you\": true\n },\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"enabled": true,
"leadMinutes": 0,
"workingDays": "weekdays",
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"membersStart": "opted_in",
"destination": "workbot_dm",
"sources": {
"calendar": "everyone",
"connections": {},
"otherConnections": [
"<string>"
],
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": true,
"checkGateThreshold": 0.5,
"sendCheck": true,
"sendCheckThreshold": 0.5
},
"template": {
"responsibilities": {
"morning_brief": true,
"meeting_prep": true,
"calendar_changes": true,
"waiting_on_you": true
},
"instructions": "<string>",
"versionId": "<string>",
"version": 4503599627370496
},
"slackReady": true,
"runnerReady": true,
"sourceConnections": {
"calendar": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"connectedMembers": 4503599627370495
}
],
"other": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"policy": "everyone"
}
],
"all": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"slots": [
"calendar"
],
"connectedMembers": 4503599627370495
}
]
},
"inherit": true,
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>",
"defaultText": "<string>",
"carriedOver": [
"checkEveryHours"
]
},
"checkGate": {
"model": true
},
"sendCheck": {
"ready": true
}
}{
"error": "invalid_working_hours",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "feature_disabled",
"feature": "<string>"
}Change the settings for a team's members' agents
Changes any subset of how members’ agents work for one team’s members, with the same body and the same checks as PUT /v1/org/workbot-settings/proactive: policy fields, sources (only the organization’s own connections, each where it can serve; an MCP only with reviewed read tools unless workbotAgentBrief is on; a core source’s default must stay allowed), brief (400 without workbotAgentBrief), responsibilities and instructions. The change is merged onto the team’s own policy. A team that followed the organization starts from the organization’s policy, sources, brief and template as they are now, and this first save makes that copy the team’s own: from then on it no longer follows the organization’s changes. A change to responsibilities or instructions adds one to the team’s template version. The team’s members follow it from their next check, including when agents are off for everyone and on for this team; a member on several teams whose own policies differ follows the organization’s. Members’ own choices are kept. To follow the organization again, send agent: { inherit: true } to PUT /v1/org/workbot-settings/teams/{teamId}. Returns the team’s policy with inherit: false. Requires Workbot on this deployment and Manage OpenWork Models.
curl --request PUT \
--url https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"enabled": true,
"leadMinutes": 0,
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"destination": "workbot_dm",
"sources": {
"otherConnections": [
"<string>"
],
"connections": {},
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": true,
"checkGateThreshold": 0.5,
"sendCheck": true,
"sendCheckThreshold": 0.5,
"responsibilities": {
"morning_brief": true,
"meeting_prep": true,
"calendar_changes": true,
"waiting_on_you": true
},
"instructions": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent"
payload = {
"enabled": True,
"leadMinutes": 0,
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"destination": "workbot_dm",
"sources": {
"otherConnections": ["<string>"],
"connections": {},
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": True,
"checkGateThreshold": 0.5,
"sendCheck": True,
"sendCheckThreshold": 0.5,
"responsibilities": {
"morning_brief": True,
"meeting_prep": True,
"calendar_changes": True,
"waiting_on_you": True
},
"instructions": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
leadMinutes: 0,
startHour: 11,
endHour: 12,
dailyCap: 5,
destination: 'workbot_dm',
sources: {otherConnections: ['<string>'], connections: {}, toolOverrides: {}},
brief: {checkEveryHours: 1, dailyCap: 5, extraChecksPerDay: 3, text: '<string>'},
checkGate: true,
checkGateThreshold: 0.5,
sendCheck: true,
sendCheckThreshold: 0.5,
responsibilities: {
morning_brief: true,
meeting_prep: true,
calendar_changes: true,
waiting_on_you: true
},
instructions: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'leadMinutes' => 0,
'startHour' => 11,
'endHour' => 12,
'dailyCap' => 5,
'destination' => 'workbot_dm',
'sources' => [
'otherConnections' => [
'<string>'
],
'connections' => [
],
'toolOverrides' => [
]
],
'brief' => [
'checkEveryHours' => 1,
'dailyCap' => 5,
'extraChecksPerDay' => 3,
'text' => '<string>'
],
'checkGate' => true,
'checkGateThreshold' => 0.5,
'sendCheck' => true,
'sendCheckThreshold' => 0.5,
'responsibilities' => [
'morning_brief' => true,
'meeting_prep' => true,
'calendar_changes' => true,
'waiting_on_you' => true
],
'instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent"
payload := strings.NewReader("{\n \"enabled\": true,\n \"leadMinutes\": 0,\n \"startHour\": 11,\n \"endHour\": 12,\n \"dailyCap\": 5,\n \"destination\": \"workbot_dm\",\n \"sources\": {\n \"otherConnections\": [\n \"<string>\"\n ],\n \"connections\": {},\n \"toolOverrides\": {}\n },\n \"brief\": {\n \"checkEveryHours\": 1,\n \"dailyCap\": 5,\n \"extraChecksPerDay\": 3,\n \"text\": \"<string>\"\n },\n \"checkGate\": true,\n \"checkGateThreshold\": 0.5,\n \"sendCheck\": true,\n \"sendCheckThreshold\": 0.5,\n \"responsibilities\": {\n \"morning_brief\": true,\n \"meeting_prep\": true,\n \"calendar_changes\": true,\n \"waiting_on_you\": true\n },\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"leadMinutes\": 0,\n \"startHour\": 11,\n \"endHour\": 12,\n \"dailyCap\": 5,\n \"destination\": \"workbot_dm\",\n \"sources\": {\n \"otherConnections\": [\n \"<string>\"\n ],\n \"connections\": {},\n \"toolOverrides\": {}\n },\n \"brief\": {\n \"checkEveryHours\": 1,\n \"dailyCap\": 5,\n \"extraChecksPerDay\": 3,\n \"text\": \"<string>\"\n },\n \"checkGate\": true,\n \"checkGateThreshold\": 0.5,\n \"sendCheck\": true,\n \"sendCheckThreshold\": 0.5,\n \"responsibilities\": {\n \"morning_brief\": true,\n \"meeting_prep\": true,\n \"calendar_changes\": true,\n \"waiting_on_you\": true\n },\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}/agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"leadMinutes\": 0,\n \"startHour\": 11,\n \"endHour\": 12,\n \"dailyCap\": 5,\n \"destination\": \"workbot_dm\",\n \"sources\": {\n \"otherConnections\": [\n \"<string>\"\n ],\n \"connections\": {},\n \"toolOverrides\": {}\n },\n \"brief\": {\n \"checkEveryHours\": 1,\n \"dailyCap\": 5,\n \"extraChecksPerDay\": 3,\n \"text\": \"<string>\"\n },\n \"checkGate\": true,\n \"checkGateThreshold\": 0.5,\n \"sendCheck\": true,\n \"sendCheckThreshold\": 0.5,\n \"responsibilities\": {\n \"morning_brief\": true,\n \"meeting_prep\": true,\n \"calendar_changes\": true,\n \"waiting_on_you\": true\n },\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"enabled": true,
"leadMinutes": 0,
"workingDays": "weekdays",
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"membersStart": "opted_in",
"destination": "workbot_dm",
"sources": {
"calendar": "everyone",
"connections": {},
"otherConnections": [
"<string>"
],
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": true,
"checkGateThreshold": 0.5,
"sendCheck": true,
"sendCheckThreshold": 0.5
},
"template": {
"responsibilities": {
"morning_brief": true,
"meeting_prep": true,
"calendar_changes": true,
"waiting_on_you": true
},
"instructions": "<string>",
"versionId": "<string>",
"version": 4503599627370496
},
"slackReady": true,
"runnerReady": true,
"sourceConnections": {
"calendar": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"connectedMembers": 4503599627370495
}
],
"other": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"policy": "everyone"
}
],
"all": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"slots": [
"calendar"
],
"connectedMembers": 4503599627370495
}
]
},
"inherit": true,
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>",
"defaultText": "<string>",
"carriedOver": [
"checkEveryHours"
]
},
"checkGate": {
"model": true
},
"sendCheck": {
"ready": true
}
}{
"error": "invalid_working_hours",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "feature_disabled",
"feature": "<string>"
}Authorizations
Path Parameters
Body
Response
The team's agent settings saved.
Was this page helpful?