Revoke document permissions
curl --request DELETE \
--url https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"userGroupIds": [
"mEhXj6ZI"
]
}
'import requests
url = "https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions"
payload = {
"userIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"userGroupIds": ["mEhXj6ZI"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({userIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], userGroupIds: ['mEhXj6ZI']})
};
fetch('https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions', 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://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'userIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'userGroupIds' => [
'mEhXj6ZI'
]
]),
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 := "https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions"
payload := strings.NewReader("{\n \"userIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"userGroupIds\": [\n \"mEhXj6ZI\"\n ]\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"userGroupIds\": [\n \"mEhXj6ZI\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"userGroupIds\": [\n \"mEhXj6ZI\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true
}
Permissions
Revoke document permissions
Revoke document permissions for users or user groups.
DELETE
/
v1
/
documents
/
{documentId}
/
permissions
Revoke document permissions
curl --request DELETE \
--url https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"userGroupIds": [
"mEhXj6ZI"
]
}
'import requests
url = "https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions"
payload = {
"userIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"userGroupIds": ["mEhXj6ZI"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({userIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], userGroupIds: ['mEhXj6ZI']})
};
fetch('https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions', 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://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'userIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'userGroupIds' => [
'mEhXj6ZI'
]
]),
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 := "https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions"
payload := strings.NewReader("{\n \"userIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"userGroupIds\": [\n \"mEhXj6ZI\"\n ]\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"userGroupIds\": [\n \"mEhXj6ZI\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"userGroupIds\": [\n \"mEhXj6ZI\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true
}
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The document identifier. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.
Body
application/json
The list of user IDs to revoke permissions from. Use the List users and List embed users endpoints to retrieve user IDs. Either userIds or userGroupIds is required.
Example:
["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
The list of user group IDs to revoke permissions from. Use the List user groups endpoint to retrieve user group IDs. Either userIds or userGroupIds is required.
Example:
["mEhXj6ZI"]
Response
Permissions revoked successfully
Example:
true
Was this page helpful?

