# Update an addon's sub-firm availability for your firm

**PUT /api/v1/addon/{addon_id}/sub-firm-availability**

Restricting availability limits which of your sub-firms can see and
install the addon to the given sub-firms (and theirs in turn).
Removing a sub-firm stops new installs there but leaves any existing
install working. An addon the network has made mandatory cannot be
restricted.


## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters

### Path parameters

- **addon_id** (string)
  The ID of the addon.



### Body: application/json (object)

- **restricted** (boolean)
  Whether availability is limited to sub_firm_uuids. False makes the addon available to every sub-firm again.

- **sub_firm_uuids** (array[string(uuid)])
  UUIDs of your sub-firms the addon is available to. Selecting a sub-firm also covers its own sub-firms. Only used when restricted is true; an empty array makes the addon available to no sub-firm.



## Responses
### 200


#### Body: application/json (object)
- **addon_id** (string)
  Unique identifier of the addon

- **name** (string)
  Name of the addon

- **restricted** (boolean)
  Whether availability is limited to the listed sub-firms. False means every sub-firm can see and install the addon.

- **sub_firms** (array[object])
  The sub-firms the addon is available to while restricted. Selecting a sub-firm also covers its own sub-firms. Empty when restricted is false.


### 422
Validation error

#### Body: application/json (object)
- **message** (string)
  A human-readable description of the error.

- **errors** (object)
  Validation messages keyed by the field that failed.



[Powered by Bump.sh](https://bump.sh)