Approvals
Create an approval policy.
POST
/
api
/
approval-policies
Create an approval policy.
curl --request POST \
--url http://localhost:3000/api/approval-policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"kind": "<string>",
"definition": {
"tiers": [
{
"min_amount_usd": "<string>",
"auto_approve": true,
"steps": [
{
"approvers": {
"roles": [
"<string>"
],
"user_ids": [
"<string>"
]
},
"quorum": "all",
"notify_only": true
}
]
}
],
"expiry_hours": 123
},
"scopeType": "<string>",
"scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true
}
'import requests
url = "http://localhost:3000/api/approval-policies"
payload = {
"name": "<string>",
"kind": "<string>",
"definition": {
"tiers": [
{
"min_amount_usd": "<string>",
"auto_approve": True,
"steps": [
{
"approvers": {
"roles": ["<string>"],
"user_ids": ["<string>"]
},
"quorum": "all",
"notify_only": True
}
]
}
],
"expiry_hours": 123
},
"scopeType": "<string>",
"scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
kind: '<string>',
definition: {
tiers: [
{
min_amount_usd: '<string>',
auto_approve: true,
steps: [
{
approvers: {roles: ['<string>'], user_ids: ['<string>']},
quorum: 'all',
notify_only: true
}
]
}
],
expiry_hours: 123
},
scopeType: '<string>',
scopeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled: true
})
};
fetch('http://localhost:3000/api/approval-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/approval-policies",
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>',
'kind' => '<string>',
'definition' => [
'tiers' => [
[
'min_amount_usd' => '<string>',
'auto_approve' => true,
'steps' => [
[
'approvers' => [
'roles' => [
'<string>'
],
'user_ids' => [
'<string>'
]
],
'quorum' => 'all',
'notify_only' => true
]
]
]
],
'expiry_hours' => 123
],
'scopeType' => '<string>',
'scopeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/approval-policies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"kind\": \"<string>\",\n \"definition\": {\n \"tiers\": [\n {\n \"min_amount_usd\": \"<string>\",\n \"auto_approve\": true,\n \"steps\": [\n {\n \"approvers\": {\n \"roles\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"quorum\": \"all\",\n \"notify_only\": true\n }\n ]\n }\n ],\n \"expiry_hours\": 123\n },\n \"scopeType\": \"<string>\",\n \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/approval-policies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"kind\": \"<string>\",\n \"definition\": {\n \"tiers\": [\n {\n \"min_amount_usd\": \"<string>\",\n \"auto_approve\": true,\n \"steps\": [\n {\n \"approvers\": {\n \"roles\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"quorum\": \"all\",\n \"notify_only\": true\n }\n ]\n }\n ],\n \"expiry_hours\": 123\n },\n \"scopeType\": \"<string>\",\n \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/approval-policies")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"kind\": \"<string>\",\n \"definition\": {\n \"tiers\": [\n {\n \"min_amount_usd\": \"<string>\",\n \"auto_approve\": true,\n \"steps\": [\n {\n \"approvers\": {\n \"roles\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"quorum\": \"all\",\n \"notify_only\": true\n }\n ]\n }\n ],\n \"expiry_hours\": 123\n },\n \"scopeType\": \"<string>\",\n \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": "budget_exceeded",
"message": "<string>",
"details": {}
}
}Authorizations
WorkOS session access token (human dashboard sessions) on the control plane.
Headers
Example:
"601c5d19-0b88-42f7-acda-d1d31abd100d"
Body
application/json
Response
OK
Resource object.
⌘I
Create an approval policy.
curl --request POST \
--url http://localhost:3000/api/approval-policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"kind": "<string>",
"definition": {
"tiers": [
{
"min_amount_usd": "<string>",
"auto_approve": true,
"steps": [
{
"approvers": {
"roles": [
"<string>"
],
"user_ids": [
"<string>"
]
},
"quorum": "all",
"notify_only": true
}
]
}
],
"expiry_hours": 123
},
"scopeType": "<string>",
"scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true
}
'import requests
url = "http://localhost:3000/api/approval-policies"
payload = {
"name": "<string>",
"kind": "<string>",
"definition": {
"tiers": [
{
"min_amount_usd": "<string>",
"auto_approve": True,
"steps": [
{
"approvers": {
"roles": ["<string>"],
"user_ids": ["<string>"]
},
"quorum": "all",
"notify_only": True
}
]
}
],
"expiry_hours": 123
},
"scopeType": "<string>",
"scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
kind: '<string>',
definition: {
tiers: [
{
min_amount_usd: '<string>',
auto_approve: true,
steps: [
{
approvers: {roles: ['<string>'], user_ids: ['<string>']},
quorum: 'all',
notify_only: true
}
]
}
],
expiry_hours: 123
},
scopeType: '<string>',
scopeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled: true
})
};
fetch('http://localhost:3000/api/approval-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/approval-policies",
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>',
'kind' => '<string>',
'definition' => [
'tiers' => [
[
'min_amount_usd' => '<string>',
'auto_approve' => true,
'steps' => [
[
'approvers' => [
'roles' => [
'<string>'
],
'user_ids' => [
'<string>'
]
],
'quorum' => 'all',
'notify_only' => true
]
]
]
],
'expiry_hours' => 123
],
'scopeType' => '<string>',
'scopeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/approval-policies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"kind\": \"<string>\",\n \"definition\": {\n \"tiers\": [\n {\n \"min_amount_usd\": \"<string>\",\n \"auto_approve\": true,\n \"steps\": [\n {\n \"approvers\": {\n \"roles\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"quorum\": \"all\",\n \"notify_only\": true\n }\n ]\n }\n ],\n \"expiry_hours\": 123\n },\n \"scopeType\": \"<string>\",\n \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/approval-policies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"kind\": \"<string>\",\n \"definition\": {\n \"tiers\": [\n {\n \"min_amount_usd\": \"<string>\",\n \"auto_approve\": true,\n \"steps\": [\n {\n \"approvers\": {\n \"roles\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"quorum\": \"all\",\n \"notify_only\": true\n }\n ]\n }\n ],\n \"expiry_hours\": 123\n },\n \"scopeType\": \"<string>\",\n \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/approval-policies")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"kind\": \"<string>\",\n \"definition\": {\n \"tiers\": [\n {\n \"min_amount_usd\": \"<string>\",\n \"auto_approve\": true,\n \"steps\": [\n {\n \"approvers\": {\n \"roles\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"quorum\": \"all\",\n \"notify_only\": true\n }\n ]\n }\n ],\n \"expiry_hours\": 123\n },\n \"scopeType\": \"<string>\",\n \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": "budget_exceeded",
"message": "<string>",
"details": {}
}
}