Users

Add Users

Use this API to add Users to organizations, folders, or documents.

  • Organization: Provides access to all documents unless they have restricted access
  • Folder: Provides access to all documents in the folder (pass folderId)
  • Document: Provides access to the specific document (pass documentId)

Access Control: Set accessRole to viewer (read-only) or editor (read/write) for each resource.

post/users/add

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": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "folderId": "yourFolderId",
    "users": [
      {
        "userId": "yourUserId1",
        "name": "User Name",
        "email": "user@email.com",
        "accessRole": "editor",
        "initial": "UN"
      }
    ]
  }
}

Response

Users processed successfully

Changes

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