Create admin automation

POST

admin-automations

cURL

curl --request POST \
  --url https://api.claap.io/v1/admin-automations \
  --header 'Content-Type: application/json' \
  --header 'X-Claap-Key: <api-key>' \
  --data '
{
  "actions": {
    "autoRecord": {
      "onlyHosted": false,
      "toBeRecorded": true
    },
    "autoShare": {
      "autoShare": "AllParticipants",
      "publicLinkEnabled": false,
      "publish": "InviteOnly"
    }
  },
  "beforeAdminAutomationId": "<string>",
  "combineWith": "Or",
  "disallowUserOverride": true,
  "filters": [],
  "name": "<string>"
}
'

import requests

url = "https://api.claap.io/v1/admin-automations"

payload = {
    "actions": {
        "autoRecord": {
            "onlyHosted": False,
            "toBeRecorded": True
        },
        "autoShare": {
            "autoShare": "AllParticipants",
            "publicLinkEnabled": False,
            "publish": "InviteOnly"
        }
    },
    "beforeAdminAutomationId": "<string>",
    "combineWith": "Or",
    "disallowUserOverride": True,
    "filters": [],
    "name": "<string>"
}
headers = {
    "X-Claap-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actions: {
      autoRecord: {onlyHosted: false, toBeRecorded: true},
      autoShare: {autoShare: 'AllParticipants', publicLinkEnabled: false, publish: 'InviteOnly'}
    },
    beforeAdminAutomationId: '<string>',
    combineWith: 'Or',
    disallowUserOverride: true,
    filters: [],
    name: '<string>'
  })
};

fetch('https://api.claap.io/v1/admin-automations', 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.claap.io/v1/admin-automations",
  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([
    'actions' => [
        'autoRecord' => [
                'onlyHosted' => false,
                'toBeRecorded' => true
        ],
        'autoShare' => [
                'autoShare' => 'AllParticipants',
                'publicLinkEnabled' => false,
                'publish' => 'InviteOnly'
        ]
    ],
    'beforeAdminAutomationId' => '<string>',
    'combineWith' => 'Or',
    'disallowUserOverride' => true,
    'filters' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Claap-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.claap.io/v1/admin-automations"

	payload := strings.NewReader("{\n  \"actions\": {\n    \"autoRecord\": {\n      \"onlyHosted\": false,\n      \"toBeRecorded\": true\n    },\n    \"autoShare\": {\n      \"autoShare\": \"AllParticipants\",\n      \"publicLinkEnabled\": false,\n      \"publish\": \"InviteOnly\"\n    }\n  },\n  \"beforeAdminAutomationId\": \"<string>\",\n  \"combineWith\": \"Or\",\n  \"disallowUserOverride\": true,\n  \"filters\": [],\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Claap-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://api.claap.io/v1/admin-automations")
  .header("X-Claap-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actions\": {\n    \"autoRecord\": {\n      \"onlyHosted\": false,\n      \"toBeRecorded\": true\n    },\n    \"autoShare\": {\n      \"autoShare\": \"AllParticipants\",\n      \"publicLinkEnabled\": false,\n      \"publish\": \"InviteOnly\"\n    }\n  },\n  \"beforeAdminAutomationId\": \"<string>\",\n  \"combineWith\": \"Or\",\n  \"disallowUserOverride\": true,\n  \"filters\": [],\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.claap.io/v1/admin-automations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actions\": {\n    \"autoRecord\": {\n      \"onlyHosted\": false,\n      \"toBeRecorded\": true\n    },\n    \"autoShare\": {\n      \"autoShare\": \"AllParticipants\",\n      \"publicLinkEnabled\": false,\n      \"publish\": \"InviteOnly\"\n    }\n  },\n  \"beforeAdminAutomationId\": \"<string>\",\n  \"combineWith\": \"Or\",\n  \"disallowUserOverride\": true,\n  \"filters\": [],\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "result": {
    "adminAutomationId": "<string>",
    "name": "<string>",
    "disallowUserOverride": true,
    "filters": [
      {
        "type": "MeetingType",
        "not": false
      }
    ],
    "actions": {
      "autoRecord": {
        "onlyHosted": false,
        "toBeRecorded": true
      },
      "autoShare": {
        "autoShare": "AllParticipants",
        "publicLinkEnabled": false,
        "publish": "InviteOnly"
      },
      "moveToFolder": {
        "folderId": "<string>"
      },
      "updateOverview": {
        "sectionIds": [
          "<string>"
        ]
      }
    }
  }
}

Creates an admin automation. By default the new automation is placed first in the list, giving it the highest priority; set beforeAdminAutomationId to insert it right before another automation instead. At least one action (autoRecord, autoShare, moveToFolder or updateOverview) is required; when name is omitted, a name is generated from the actions and filters.

Authorizations

X-Claap-Key

string

header

required

Body

application/json

actions

object

required

The actions applied to matching meetings. At least one of autoRecord, autoShare, moveToFolder or updateOverview must be defined.

Option 1
Option 2
Option 3
Option 4

Show child attributes

beforeAdminAutomationId

string

Identifier of an existing admin automation to insert the new automation right before. When omitted, the new automation is placed first in the list.

combineWith

enum<string>

default:Or

The operator used to combine the filters. It is applied to every filter that does not define its own combineWith value.

Available options:

And,

Or

disallowUserOverride

boolean

default:true

Whether the automation is enforced, preventing members from overriding it with their personal preferences.

filters

The filters selecting which meetings the automation applies to. When omitted or empty, the automation applies to all meetings.

A filter selecting which meetings an admin automation applies to.

Show child attributes

name

string

The admin automation name. When omitted, a name is generated from the actions and filters.

Response

Admin automation was successfully created

result

object

required

An admin automation (recording automation configured by workspace admins).

Show child attributes

Update admin automationReplace an admin automation. This is a full replacement, not a partial update: the automation becomes exactly what is sent, and omitted attributes are reset to their default values instead of being preserved.

cURL

curl --request POST \
  --url https://api.claap.io/v1/admin-automations \
  --header 'Content-Type: application/json' \
  --header 'X-Claap-Key: <api-key>' \
  --data '
{
  "actions": {
    "autoRecord": {
      "onlyHosted": false,
      "toBeRecorded": true
    },
    "autoShare": {
      "autoShare": "AllParticipants",
      "publicLinkEnabled": false,
      "publish": "InviteOnly"
    }
  },
  "beforeAdminAutomationId": "<string>",
  "combineWith": "Or",
  "disallowUserOverride": true,
  "filters": [],
  "name": "<string>"
}
'

import requests

url = "https://api.claap.io/v1/admin-automations"

payload = {
    "actions": {
        "autoRecord": {
            "onlyHosted": False,
            "toBeRecorded": True
        },
        "autoShare": {
            "autoShare": "AllParticipants",
            "publicLinkEnabled": False,
            "publish": "InviteOnly"
        }
    },
    "beforeAdminAutomationId": "<string>",
    "combineWith": "Or",
    "disallowUserOverride": True,
    "filters": [],
    "name": "<string>"
}
headers = {
    "X-Claap-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actions: {
      autoRecord: {onlyHosted: false, toBeRecorded: true},
      autoShare: {autoShare: 'AllParticipants', publicLinkEnabled: false, publish: 'InviteOnly'}
    },
    beforeAdminAutomationId: '<string>',
    combineWith: 'Or',
    disallowUserOverride: true,
    filters: [],
    name: '<string>'
  })
};

fetch('https://api.claap.io/v1/admin-automations', 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.claap.io/v1/admin-automations",
  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([
    'actions' => [
        'autoRecord' => [
                'onlyHosted' => false,
                'toBeRecorded' => true
        ],
        'autoShare' => [
                'autoShare' => 'AllParticipants',
                'publicLinkEnabled' => false,
                'publish' => 'InviteOnly'
        ]
    ],
    'beforeAdminAutomationId' => '<string>',
    'combineWith' => 'Or',
    'disallowUserOverride' => true,
    'filters' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Claap-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.claap.io/v1/admin-automations"

	payload := strings.NewReader("{\n  \"actions\": {\n    \"autoRecord\": {\n      \"onlyHosted\": false,\n      \"toBeRecorded\": true\n    },\n    \"autoShare\": {\n      \"autoShare\": \"AllParticipants\",\n      \"publicLinkEnabled\": false,\n      \"publish\": \"InviteOnly\"\n    }\n  },\n  \"beforeAdminAutomationId\": \"<string>\",\n  \"combineWith\": \"Or\",\n  \"disallowUserOverride\": true,\n  \"filters\": [],\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Claap-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://api.claap.io/v1/admin-automations")
  .header("X-Claap-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actions\": {\n    \"autoRecord\": {\n      \"onlyHosted\": false,\n      \"toBeRecorded\": true\n    },\n    \"autoShare\": {\n      \"autoShare\": \"AllParticipants\",\n      \"publicLinkEnabled\": false,\n      \"publish\": \"InviteOnly\"\n    }\n  },\n  \"beforeAdminAutomationId\": \"<string>\",\n  \"combineWith\": \"Or\",\n  \"disallowUserOverride\": true,\n  \"filters\": [],\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.claap.io/v1/admin-automations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actions\": {\n    \"autoRecord\": {\n      \"onlyHosted\": false,\n      \"toBeRecorded\": true\n    },\n    \"autoShare\": {\n      \"autoShare\": \"AllParticipants\",\n      \"publicLinkEnabled\": false,\n      \"publish\": \"InviteOnly\"\n    }\n  },\n  \"beforeAdminAutomationId\": \"<string>\",\n  \"combineWith\": \"Or\",\n  \"disallowUserOverride\": true,\n  \"filters\": [],\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "result": {
    "adminAutomationId": "<string>",
    "name": "<string>",
    "disallowUserOverride": true,
    "filters": [
      {
        "type": "MeetingType",
        "not": false
      }
    ],
    "actions": {
      "autoRecord": {
        "onlyHosted": false,
        "toBeRecorded": true
      },
      "autoShare": {
        "autoShare": "AllParticipants",
        "publicLinkEnabled": false,
        "publish": "InviteOnly"
      },
      "moveToFolder": {
        "folderId": "<string>"
      },
      "updateOverview": {
        "sectionIds": [
          "<string>"
        ]
      }
    }
  }
}

API documentation

Recording

Deal

Company

Contact

Admin automation

Workspace

Webhook

Create admin automation

Authorizations

Body

Response