API Reference
API ReferenceGuides

Update Access Group

patch
https://api.unloc.app/v2/projects//access-groups/

Update Access Group data, like name. To update the access (App Users and Locks) in this Access Group, use the update access endpoint.

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
string
length between 4 and 64

The name of this Access Group.

string | null

The description of this Access Group.

recurrence
object | null

Days of the week when Keys created for this Access Group will be usable.

string

Whether users should be allowed to share keys to the locks in this Access Group. Not allowed in combination with recurrence.

metadata
object | null

Additional custom data linked to this entity presented in a key–value pairs format. Use this to store additional data that is not part of the core data model. Up to 20 key–value pairs are supported. Each key's length can be up to 40 characters long, and each value's maximum length is 256. Setting a value to null will remove the key–value pair from the metadata. Metadata Keys with the prefix unloc is reserved, and can be overwritten by the system.

Responses

Updated 29 days ago

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 29 days ago