API Reference
API ReferenceGuides

Update accesses for an Access Group

post
https://api.unloc.app/v2/projects//access-groups//update-accesses

Update accesses for an Access Group by adding or removing App Users and Locks.
Adding Users and Locks to this Access Group will result in a Key for each combination of User and Lock.

Note:

  • An Access Group can at most have 100 000 accesses, meaning the product of the number of App Users and Locks cannot exceed 100 000.
Required Scopeproject.admin
Required ModulemobileKey
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the Project. Must match the one in the JWT.

string
required

ID of the Access Group.

Body Params

Access Group accesses to update.

At least one of the properties appUserIdsToAdd, appUserIdsToRemove, lockIdsToAdd or lockIdsToRemove must be provided.

appUserIdsToAdd
array of strings

List of App User IDs to add to the Access Group.
If an App User is already in the Access Group, it will be ignored.
Providing invalid App User IDs or non existing App Users, will result in an error.

appUserIdsToAdd
appUserIdsToRemove
array of strings

List of App User IDs to remove from the Access Group.
If an App User is not in the Access Group, it will be ignored.
Providing invalid App User IDs will result in an error.

appUserIdsToRemove
lockIdsToAdd
array of strings

List of Lock IDs to add to the Access Group.
If a Lock is already in the Access Group, it will be ignored.
Providing Lock IDs that dont exist, either at all or in this Project, will result in an error.

lockIdsToAdd
lockIdsToRemove
array of strings

List of Lock IDs to remove from the Access Group.
If a Lock is not in the Access Group, it will be ignored.

lockIdsToRemove
inviteNotification

Controls the invite notification (push or SMS) that tells an App User about a new Key.

Omit this object to notify as soon as the Keys are created.

Delivery is throttled by mode:

  • immediate: notify as soon as the Keys are created. Same as omitting the object.
  • none: never notify.
  • delayed: notify no earlier than notBefore. Use this when Keys are created outside the
    hours your users want to hear from you, such as during a nightly sync.

delayed sets the earliest delivery time, not an exact one. Choose the same notBefore for
every request in a batch: Keys that become due together are announced in a single notification
per user, while Keys spread over a longer window produce several.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?