cURL
curl --request POST \
--url https://www.getinboxzero.com/api/v1/rules \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"condition": {
"aiInstructions": "<string>",
"static": {
"from": "<string>",
"to": "<string>",
"subject": "<string>"
}
},
"actions": [
{
"messagingChannelId": "<string>",
"fields": {
"label": "<string>",
"to": "<string>",
"cc": "<string>",
"bcc": "<string>",
"subject": "<string>",
"content": "<string>",
"webhookUrl": "<string>",
"folderName": "<string>"
},
"delayInMinutes": 123
}
],
"runOnThreads": true
}
'import requests
url = "https://www.getinboxzero.com/api/v1/rules"
payload = {
"name": "<string>",
"condition": {
"aiInstructions": "<string>",
"static": {
"from": "<string>",
"to": "<string>",
"subject": "<string>"
}
},
"actions": [
{
"messagingChannelId": "<string>",
"fields": {
"label": "<string>",
"to": "<string>",
"cc": "<string>",
"bcc": "<string>",
"subject": "<string>",
"content": "<string>",
"webhookUrl": "<string>",
"folderName": "<string>"
},
"delayInMinutes": 123
}
],
"runOnThreads": True
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
condition: {
aiInstructions: '<string>',
static: {from: '<string>', to: '<string>', subject: '<string>'}
},
actions: [
{
messagingChannelId: '<string>',
fields: {
label: '<string>',
to: '<string>',
cc: '<string>',
bcc: '<string>',
subject: '<string>',
content: '<string>',
webhookUrl: '<string>',
folderName: '<string>'
},
delayInMinutes: 123
}
],
runOnThreads: true
})
};
fetch('https://www.getinboxzero.com/api/v1/rules', 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://www.getinboxzero.com/api/v1/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'condition' => [
'aiInstructions' => '<string>',
'static' => [
'from' => '<string>',
'to' => '<string>',
'subject' => '<string>'
]
],
'actions' => [
[
'messagingChannelId' => '<string>',
'fields' => [
'label' => '<string>',
'to' => '<string>',
'cc' => '<string>',
'bcc' => '<string>',
'subject' => '<string>',
'content' => '<string>',
'webhookUrl' => '<string>',
'folderName' => '<string>'
],
'delayInMinutes' => 123
]
],
'runOnThreads' => true
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$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://www.getinboxzero.com/api/v1/rules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"condition\": {\n \"aiInstructions\": \"<string>\",\n \"static\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"subject\": \"<string>\"\n }\n },\n \"actions\": [\n {\n \"messagingChannelId\": \"<string>\",\n \"fields\": {\n \"label\": \"<string>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"folderName\": \"<string>\"\n },\n \"delayInMinutes\": 123\n }\n ],\n \"runOnThreads\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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.post("https://www.getinboxzero.com/api/v1/rules")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"condition\": {\n \"aiInstructions\": \"<string>\",\n \"static\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"subject\": \"<string>\"\n }\n },\n \"actions\": [\n {\n \"messagingChannelId\": \"<string>\",\n \"fields\": {\n \"label\": \"<string>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"folderName\": \"<string>\"\n },\n \"delayInMinutes\": 123\n }\n ],\n \"runOnThreads\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.getinboxzero.com/api/v1/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"condition\": {\n \"aiInstructions\": \"<string>\",\n \"static\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"subject\": \"<string>\"\n }\n },\n \"actions\": [\n {\n \"messagingChannelId\": \"<string>\",\n \"fields\": {\n \"label\": \"<string>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"folderName\": \"<string>\"\n },\n \"delayInMinutes\": 123\n }\n ],\n \"runOnThreads\": true\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"id": "<string>",
"name": "<string>",
"enabled": true,
"runOnThreads": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": {
"aiInstructions": "<string>",
"static": {
"from": "<string>",
"to": "<string>",
"subject": "<string>"
}
},
"actions": [
{
"messagingChannelId": "<string>",
"fields": {
"label": "<string>",
"to": "<string>",
"cc": "<string>",
"bcc": "<string>",
"subject": "<string>",
"content": "<string>",
"webhookUrl": "<string>",
"folderName": "<string>"
},
"delayInMinutes": 123
}
]
}
}API
Create rule
Create an automation rule for the scoped inbox account.
POST
/
rules
cURL
curl --request POST \
--url https://www.getinboxzero.com/api/v1/rules \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"condition": {
"aiInstructions": "<string>",
"static": {
"from": "<string>",
"to": "<string>",
"subject": "<string>"
}
},
"actions": [
{
"messagingChannelId": "<string>",
"fields": {
"label": "<string>",
"to": "<string>",
"cc": "<string>",
"bcc": "<string>",
"subject": "<string>",
"content": "<string>",
"webhookUrl": "<string>",
"folderName": "<string>"
},
"delayInMinutes": 123
}
],
"runOnThreads": true
}
'import requests
url = "https://www.getinboxzero.com/api/v1/rules"
payload = {
"name": "<string>",
"condition": {
"aiInstructions": "<string>",
"static": {
"from": "<string>",
"to": "<string>",
"subject": "<string>"
}
},
"actions": [
{
"messagingChannelId": "<string>",
"fields": {
"label": "<string>",
"to": "<string>",
"cc": "<string>",
"bcc": "<string>",
"subject": "<string>",
"content": "<string>",
"webhookUrl": "<string>",
"folderName": "<string>"
},
"delayInMinutes": 123
}
],
"runOnThreads": True
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
condition: {
aiInstructions: '<string>',
static: {from: '<string>', to: '<string>', subject: '<string>'}
},
actions: [
{
messagingChannelId: '<string>',
fields: {
label: '<string>',
to: '<string>',
cc: '<string>',
bcc: '<string>',
subject: '<string>',
content: '<string>',
webhookUrl: '<string>',
folderName: '<string>'
},
delayInMinutes: 123
}
],
runOnThreads: true
})
};
fetch('https://www.getinboxzero.com/api/v1/rules', 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://www.getinboxzero.com/api/v1/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'condition' => [
'aiInstructions' => '<string>',
'static' => [
'from' => '<string>',
'to' => '<string>',
'subject' => '<string>'
]
],
'actions' => [
[
'messagingChannelId' => '<string>',
'fields' => [
'label' => '<string>',
'to' => '<string>',
'cc' => '<string>',
'bcc' => '<string>',
'subject' => '<string>',
'content' => '<string>',
'webhookUrl' => '<string>',
'folderName' => '<string>'
],
'delayInMinutes' => 123
]
],
'runOnThreads' => true
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$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://www.getinboxzero.com/api/v1/rules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"condition\": {\n \"aiInstructions\": \"<string>\",\n \"static\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"subject\": \"<string>\"\n }\n },\n \"actions\": [\n {\n \"messagingChannelId\": \"<string>\",\n \"fields\": {\n \"label\": \"<string>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"folderName\": \"<string>\"\n },\n \"delayInMinutes\": 123\n }\n ],\n \"runOnThreads\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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.post("https://www.getinboxzero.com/api/v1/rules")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"condition\": {\n \"aiInstructions\": \"<string>\",\n \"static\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"subject\": \"<string>\"\n }\n },\n \"actions\": [\n {\n \"messagingChannelId\": \"<string>\",\n \"fields\": {\n \"label\": \"<string>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"folderName\": \"<string>\"\n },\n \"delayInMinutes\": 123\n }\n ],\n \"runOnThreads\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.getinboxzero.com/api/v1/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"condition\": {\n \"aiInstructions\": \"<string>\",\n \"static\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"subject\": \"<string>\"\n }\n },\n \"actions\": [\n {\n \"messagingChannelId\": \"<string>\",\n \"fields\": {\n \"label\": \"<string>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"folderName\": \"<string>\"\n },\n \"delayInMinutes\": 123\n }\n ],\n \"runOnThreads\": true\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"id": "<string>",
"name": "<string>",
"enabled": true,
"runOnThreads": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": {
"aiInstructions": "<string>",
"static": {
"from": "<string>",
"to": "<string>",
"subject": "<string>"
}
},
"actions": [
{
"messagingChannelId": "<string>",
"fields": {
"label": "<string>",
"to": "<string>",
"cc": "<string>",
"bcc": "<string>",
"subject": "<string>",
"content": "<string>",
"webhookUrl": "<string>",
"folderName": "<string>"
},
"delayInMinutes": 123
}
]
}
}Authorizations
Body
application/json
Response
201 - application/json
Successful response
Show child attributes
Show child attributes
⌘I