Report - Un-shares a report with a user

Method to Unshare the Report to sharedWith user

Unshare the report with the specified user

delete

/reports/{reportId}/unshare

Authorizations

Path parameters

reportIdstring · uuidrequired

ReportId of type GUID

Query parameters

versionstring · default: 1.0

The requested API version

Header parameters

embedfast-user-idstring

Optional User Id

Body

application/jsontext/jsonapplication/*+json

sharedWithobject[] | nullable

Class for the user model to send in the Share Report Request

notifyByEmailboolean

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the NotifyByEmail property.

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/reports/{reportId}/unshare' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "sharedWith": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "text"
      }
    ],
    "notifyByEmail": true
  }'

200

400

403

404

500

200

text/plain

application/json

text/json

text/plain

{
  "message": "Success Message",
  "statusCode": 200
}

Success: The report was successfully unshared with the specified user.