Change my agent
curl --request PUT \
--url https://api.openworklabs.com/v1/me/agent \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"on": true,
"snooze": "tomorrow",
"mute": [],
"unmute": []
}
'import requests
url = "https://api.openworklabs.com/v1/me/agent"
payload = {
"on": True,
"snooze": "tomorrow",
"mute": [],
"unmute": []
}
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({on: true, snooze: 'tomorrow', mute: [], unmute: []})
};
fetch('https://api.openworklabs.com/v1/me/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/me/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([
'on' => true,
'snooze' => 'tomorrow',
'mute' => [
],
'unmute' => [
]
]),
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/me/agent"
payload := strings.NewReader("{\n \"on\": true,\n \"snooze\": \"tomorrow\",\n \"mute\": [],\n \"unmute\": []\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/me/agent")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"on\": true,\n \"snooze\": \"tomorrow\",\n \"mute\": [],\n \"unmute\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/me/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 \"on\": true,\n \"snooze\": \"tomorrow\",\n \"mute\": [],\n \"unmute\": []\n}"
response = http.request(request)
puts response.read_body{
"available": true,
"on": true,
"snoozedUntil": "2023-11-07T05:31:56Z",
"responsibilities": [
{
"id": "morning_brief",
"label": "<string>",
"tells": "<string>",
"enabled": true,
"muted": true
}
],
"destination": {
"kind": "workbot_dm",
"name": "<string>",
"blocked": "slack_app_not_installed"
},
"workingHours": {
"workingDays": "weekdays",
"startHour": 123,
"endHour": 123,
"dailyCap": 123
},
"nextCheckAt": "2023-11-07T05:31:56Z"
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "feature_disabled",
"feature": "<string>"
}Users
Change my agent
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). Organization settings and limits still apply. Requires the workbotProactive feature and Workbot on this deployment.
PUT
/
v1
/
me
/
agent
Change my agent
curl --request PUT \
--url https://api.openworklabs.com/v1/me/agent \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"on": true,
"snooze": "tomorrow",
"mute": [],
"unmute": []
}
'import requests
url = "https://api.openworklabs.com/v1/me/agent"
payload = {
"on": True,
"snooze": "tomorrow",
"mute": [],
"unmute": []
}
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({on: true, snooze: 'tomorrow', mute: [], unmute: []})
};
fetch('https://api.openworklabs.com/v1/me/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/me/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([
'on' => true,
'snooze' => 'tomorrow',
'mute' => [
],
'unmute' => [
]
]),
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/me/agent"
payload := strings.NewReader("{\n \"on\": true,\n \"snooze\": \"tomorrow\",\n \"mute\": [],\n \"unmute\": []\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/me/agent")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"on\": true,\n \"snooze\": \"tomorrow\",\n \"mute\": [],\n \"unmute\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/me/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 \"on\": true,\n \"snooze\": \"tomorrow\",\n \"mute\": [],\n \"unmute\": []\n}"
response = http.request(request)
puts response.read_body{
"available": true,
"on": true,
"snoozedUntil": "2023-11-07T05:31:56Z",
"responsibilities": [
{
"id": "morning_brief",
"label": "<string>",
"tells": "<string>",
"enabled": true,
"muted": true
}
],
"destination": {
"kind": "workbot_dm",
"name": "<string>",
"blocked": "slack_app_not_installed"
},
"workingHours": {
"workingDays": "weekdays",
"startHour": 123,
"endHour": 123,
"dailyCap": 123
},
"nextCheckAt": "2023-11-07T05:31:56Z"
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "feature_disabled",
"feature": "<string>"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Body
application/json
Available options:
tomorrow Maximum array length:
4Available options:
morning_brief, meeting_prep, calendar_changes, waiting_on_you Maximum array length:
4Available options:
morning_brief, meeting_prep, calendar_changes, waiting_on_you Response
The member's agent after the change.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Was this page helpful?