Skip to main content
PATCH
/
v1
/
organizations
/
{id}
/
shares
/
{shareId}
Update a resource share (admin only)
curl --request PATCH \
  --url http://0.0.0.0:3000/v1/organizations/{id}/shares/{shareId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "can_view": true,
  "can_control": true,
  "can_edit": false
}
'
import requests

url = "http://0.0.0.0:3000/v1/organizations/{id}/shares/{shareId}"

payload = {
"can_view": True,
"can_control": True,
"can_edit": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({can_view: true, can_control: true, can_edit: false})
};

fetch('http://0.0.0.0:3000/v1/organizations/{id}/shares/{shareId}', 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://0.0.0.0:3000/v1/organizations/{id}/shares/{shareId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'can_view' => true,
'can_control' => true,
'can_edit' => false
]),
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://0.0.0.0:3000/v1/organizations/{id}/shares/{shareId}"

payload := strings.NewReader("{\n \"can_view\": true,\n \"can_control\": true,\n \"can_edit\": false\n}")

req, _ := http.NewRequest("PATCH", 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.patch("http://0.0.0.0:3000/v1/organizations/{id}/shares/{shareId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"can_view\": true,\n \"can_control\": true,\n \"can_edit\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://0.0.0.0:3000/v1/organizations/{id}/shares/{shareId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"can_view\": true,\n \"can_control\": true,\n \"can_edit\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": 1,
  "can_view": true,
  "can_control": true,
  "can_edit": false
}
{
"message": "validation error"
}
{
"error": "unauthorized"
}
{
"error": "forbidden"
}
{
"message": "not found"
}
{
"error": "internal_error"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID da organização

shareId
integer
required

ID numérico do compartilhamento

Body

application/json
can_view
boolean
can_control
boolean
can_edit
boolean

Response

Share updated