Skip to main content

Edit Share Permission for a Session

Edits the specified share permission for the session.

Tip

The "shareId" in the request is the same as the "id" value in the request body.

Authorizations: Sessions - ACCESS

Requests

CODE
PUT /apis/sessions/:sessionId/shares/:shareId
{
  "id": "a78758cc-48da-47ad-bc6e-6c8564badb7e",
  "shareType": "USER",
  "permission": "WATCH",
  "name": "viewer",
  "email": null
}

Response

Success

CODE
{
  "data": {
    "id": "a78758cc-48da-47ad-bc6e-6c8564badb7e",
    "shareType": "USER",
    "permission": "WATCH",
    "name": "viewer",
    "email": null
  }
}

Error

Code

Payload

 Description

400

{"code":"010001", "name":"InputValidation",
"message":<Error message>, "httpStatusCode":400}

Supplied data was insufficient or incorrect.

403

{"code":"030003", "name":"CannotShare",
"message":"Cannot share", "httpStatusCode":403}

User is not allowed to share to this permission ID.

Ex.: User has the WATCH access permission but is trying to share to the OWN level.

404

{"code":"040021", "name":"UserGroupNotFound",
"message":"User or Group not found",
"httpStatusCode":404}

No user or group was found.
404

{"code": "040025",
"name":"SharePermissionNotFound",
"message": "Share permission not found",
"httpStatusCode": 404}

The specified access permission was not found.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.