Report - Shares a report with a user

PreviousReport - Retrieves a list of shared or paginated reports for the user NextReport - Retrieves users for sharing a report

Last updated 2 months ago

post

/reports/{reportId}/share

Authorizations

Path parameters

reportIdstring uuidrequired

Enter ID of the report to share.

Query parameters

versionstring

The requested API version

Header parameters

embedfast-user-idstring

Optional User Id

Body

sharedWithnullable object[]

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

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/reports/{reportId}/share' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"sharedWith":[{}]}'

200

400

403

404

500

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

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

Share the requested report to the specified user.