Organizations

Update Disabled State for Organizations

Use this API to enable or disable both read and write access for all documents for all users.

Use case: Disable access when a customer's trial or subscription has ended.

post/organizations/access/disablestate/update

Request

  • Base URL
    https://api.velt.dev/v2
  • Auth
    API key in header x-velt-api-key and API key in header x-velt-auth-token

Request body

Example request

{
  "data": {
    "organizationIds": [
      "yourOrganizationId1",
      "yourOrganizationId2"
    ],
    "disabled": true
  }
}

Response

Disabled state updated successfully

Example response

{
  "result": {
    "status": "success",
    "message": "Operation completed successfully"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.