Assigning Multiple Users to One Endpoint

There may be a use case where multiple users connect to the same endpoint. The process below allows you to assign multiple users to one endpoint. If one user's machine is off, it allows another user's machine to be pinged during the same request, until an active agent is reached to complete the request.

Follow the below steps to assign multiple users to one endpoint:

  1. Create first user via the API
  2. Create company via the API
  3. Create a new user via the API but include an array in the JSON request with a name of endpointIds
    1. The contents of endpointIds is an array of a string
    2. Each string represents an endpointId to which you'd like to give a user access

Example:

{
   "agentToken":"",
   "companyId":"",
   "dateTimeCreated":"",
   "externalId":"",
   "id":"",
   "isActive":true,
   "endpointIds": [
     "ENDPOINT_ID_FROM_COMPANY_CREATE"
    ]
}

Important Notes

  • The QuickBooks Desktop file must be located at the same path for all users
  • Users may be assigned to multiple endpoints using this process
  • If one machine is off, this allows another connected machine to be pinged
  • This process will need to be done for each user as each user must have their own unique token
  • When a request is sent to view all endpoints, an endpoint will be listed multiple times based on how many users are assigned to it.

Did this page help you?