Update site share

Creates or updates a site share entry that grants a specific user a particular access level (IS_OWNER, CAN_EDIT, or CAN_VIEW) on the specified site.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do

Creates or updates a site share entry that grants a specific user a particular access level (IS_OWNER, CAN_EDIT, or CAN_VIEW) on the specified site. If no userId is provided, the share is created for the currently authenticated user. The response contains the userId, siteId, and the resulting shareType. Requires ALL or SHARED inventory sharing permission; at SHARED level the caller's own share must be higher than CAN_VIEW and at least as high as both the share granted and the share it replaces (unless the target is a user the caller owns), so a sharer can neither promote anyone above its own level nor demote the owner. IS_OWNER lets its holder delete the site, so granting it also needs the right to delete it yourself: DELETE on inventory at ALL level, or at SHARED level an IS_OWNER share of your own.

Form Params

siteId integer required

Unique identifier of the site to share. Must be a positive number referencing an existing, non-deleted site

4001

shareType string required

Access level to grant. Allowed values: IS_OWNER (full ownership), CAN_EDIT (read/write access), CAN_VIEW (read-only access)

CAN_EDIT

userId integer

Unique identifier of the user to grant the share to. If omitted, the share is created for the currently authenticated user

5001

Responses

200

Site share updated successfully

400

Invalid request data

401

Authentication error

403

Insufficient sharing permissions, or IS_OWNER requested without the right to delete the site

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'siteId=4001' \
  --data-urlencode 'shareType=CAN_EDIT' \
  --data-urlencode 'userId=5001'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"siteId": "4001", "shareType": "CAN_EDIT", "userId": "5001"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"siteId":"4001","shareType":"CAN_EDIT","userId":"5001"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("siteId=4001&shareType=CAN_EDIT&userId=5001"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["siteId"] = "4001", ["shareType"] = "CAN_EDIT", ["userId"] = "5001" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do", strings.NewReader(`siteId=4001&shareType=CAN_EDIT&userId=5001`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'siteId=4001&shareType=CAN_EDIT&userId=5001');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/siteShares/update.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('siteId' => "4001", 'shareType' => "CAN_EDIT", 'userId' => "5001")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body