POST
/
v1
/
organizations
/
access
/
disablestate
/
update

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

Let’s say your customer’s trial or subscription has ended and you want to disable their access to the Velt data, you could use this to disable access to the entire organization data.
If organization does not exist, it will be created.

​
Endpoint

POST https://api.velt.dev/v1/organizations/access/disablestate/update

​
Headers

x-velt-api-key
string
required

Your API key.

x-velt-auth-token
string
required

Your Auth Token.

​
Body Example

​
Params

data
object
required

​
Example Requests

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

​
Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "Updated disable state for Organization(s) successfully.",
    "data": {
      "yourOrganizationId1": {
        "success": true,
        "id": "02cf91e5e7a5f4c0b600c84cf248384b",
        "message": "Updated disable state for organization Successfully"
      },
      "yourOrganizationId2": {
        "success": false,
        "id": "44e0132f4c6b0d453f18df42d2263b4e",
        "message": "Organization does not exist"
      }
    }
  }
}

​
Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

Was this page helpful?

Get Organizations v2Add Documents