Revoke a grant

DELETE

/v1/workspaces/{workspaceId}/grants/{grantId}

const url = 'https://shareout.site/v1/workspaces/example/grants/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://shareout.site/v1/workspaces/example/grants/example \
  --header 'Authorization: Bearer <token>'

Hard delete, effective within about a minute. Workspace admins, or the folder’s manager for a grant on a folder. Not gated on the external-sharing entitlement, so access can always be removed.

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

grantId

required

string

Responses

200

Revoked

404

Resource not found

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}